Генерация HTML-документации с помощью Swagger 2.x через Maven

Question

Я смотрю на создание некоторой документации API, надеюсь, используя Swagger, в нескольких моих проектах.Никогда не использовав Swagger, я пытаюсь найти очень простое решение для генерации HTML-документов через Maven.

Базовая среда REST, используемая в этих проектах, - это Джерси.Я нашел документацию от Swagger , но, похоже, нет примеров простого создания HTML-файлов.Кажется, что большинство их примеров встраивают документацию API в сам сервис.

Итак, мои вопросы:

• Как я могу генерировать HTML-документацию с помощью Swagger через Maven?
• Прикрепляет ли документация вместе со службой, как обычно, к REST?приложения?

Answer 1

Вам нужно будет использовать swagger-codegen для генерации HTML.

https://github.com/swagger-api/swagger-codegen#generating-static-html-api-documentation

Чтобы сгенерировать HTML-документ с помощью swagger-codegen, сначала необходимо сгенерировать документацию OpenAPI.Поскольку вы уже используете Jersey в качестве своей среды REST, вероятно, проще всего добавить в ваш проект сваггер как зависимость и аннотировать все ваши сервлеты API.Это скажет swagger прочитать весь ваш код и сгенерировать спецификацию OpenAPI.Чтобы начать, выполните действия, описанные в https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration.

Удачи!