Можно ли использовать spring-auto-restdocs с Swagger / SpringFox? - PullRequest
0 голосов
/ 28 мая 2018

Можно ли использовать spring-auto-restdocs с Swagger / SpringFox, swagger2markup?

Я хотел бы: - Использовать Swagger / SpringFox для предоставления тестовой области, НО тогда я хочу примеры в этомПользовательский интерфейс должен быть похож на то, что делает Spring-restdoc для предоставления примеров фрагментов кода И - Используйте spring-auto-restdocs для получения документации из POJO, представляющей ваш JSON-объект, просто добавляя Javadoc в поля, а не аннотации swagger

1 Ответ

0 голосов
/ 28 мая 2018

Я не вижу простого способа добиться этого.Без использования какого-либо кода Swagger (аннотаций или SpringFox DSL) SpringFox или swagger2markup не очень полезны.Если у вас есть и аннотации Swagger, и Spring (Auto) REST Docs, возможно, будет возможно включить фрагменты AsciiDoc, сгенерированные Spring (Auto) REST Docs, в AsciiDoc, используемый для swagger2markup.AsciiDoc поддерживает включение других файлов AsciiDoc, и эта функция также используется при включении фрагментов Spring REST Docs в рукописную документацию.

Я рассмотрел создание файлов Swagger / OpenAPI из фрагментов REST Docs и написал руководство покак это сделать https://github.com/fbenz/restdocs-to-swagger Однако это скорее комбинация инструментов, чем простая интеграция.Более того, документация по полям и методам не входит в файлы / интерфейс Swagger.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...