Как создавать автономные документы API Swagger?

У меня есть spring загрузочное Java-приложение MVC для Java. Мне удалось интегрировать документацию Springfox для API. Я могу визуально видеть все API-интерфейсы, когда сервер работает и работает.

Как я могу создать документацию API для альянса SWLINE? Примечание. Я не хотел бы использовать документацию asciidoc или markdown, но я хотел бы иметь тот же пользовательский интерфейс API swagger в html файлах. Мне бы хотелось, чтобы ссылки относились к локальному каталогу, а не к локальным хост-серверам. Благодаря

ОТВЕТЫ

Ответ 1

Springfox позволяет легко создавать теги Swagger/API docs на основе аннотаций Spring.

У самого Swagger есть некоторые инструменты, позволяющие создавать автономную/статическую документацию:

  • Редактор Swagger имеет несколько способов генерации документации, указанной в меню Создать клиент
  • Модуль Swagger Codegen позволяет создавать статический и динамический HTML-документ

Для обоих из них требуется файл JAML Swagger или JSON. Если у вас нет определения Swagger в YAML/JSON, потому что вы используете Springfox, вы можете использовать сгенерированный файл, используемый для интерфейса Swagger (/v2/api-docs?group=<group name>).

Ответ 2

Swagger имеет инструмент для создания автономных документов.

Инструмент " Swagger2Markup ", который находится на Github.

Вывод "Swagger2Markup" может использоваться в качестве альтернативы Swagger-UI и может служить статическим контентом.

Вот пример

Удачи! :)

Ответ 3

Вы можете попробовать "HTML" или "Динамический HTML" в меню "Создать клиент" в https://editor.swagger.io. Для любой проблемы/обратной связи со статическим документом, пожалуйста, сообщите в Swagger Codegen Github repo.

editor.swagger.io использует https://generator.swagger.io для генерации кода и генератора .swagger.io(Swagger Generator) является частью Swagger Проект Codegen.

Ответ 4

Вы можете взглянуть на https://www.DynamicApis.com. Вы можете создать портал API и загрузить свои JAON-документы. Этот сайт берет документ Swagger и создает гораздо более удобный пользовательский интерфейс для вашего API вместе с некоторыми довольно классными инструментами.

Здесь приведен пример API-интерфейса портала, который имеет документацию по одному из своих API.

Ответ 5

Pretty-swag - это интерфейс для спецификации Swagger V2, способный генерировать статический HTML в других форматах. Он вдохновлен Редактором Swagger.

checkout https://github.com/twskj/pretty-swag

Ответ 6

Откройте живое чванство HTML. нажмите на расширение всех операций. Затем сохраните HTML как PDF.

Это должно дать вам приличную документацию PDF API со всеми деталями.