Swagger пользовательская документация

Question

Есть ли способ создать файл README.md из swagger? Я хотел бы добавить аналогичные детали, которые можно найти на веб-странице swagger, а также некоторые пользовательские комментарии.

Кроме того, есть ли способ сделать агрегатную веб-страницу swagger? Я хочу, чтобы все развязные веб-страницы со всех микро-сервисов также были в одном месте. Это может позволить мне лучше представить себе представление о моей системе и, возможно, выполнить некоторые запросы, например, «сколько способов одна сущность может получить эту другую сущность?».

Answer 1

Относительно файла README.md - не уверен, какую информацию вы хотите включить в него, но вы можете написать свой собственный метод, который сделает это, используя Swagger Parser , чтобы получить необходимую информацию из спецификации Swagger.

Что касается агрегированного чванства - вы можете использовать Swagger-агрегат для этой цели.