Grails 2: возможно ли использовать Swagger для документирования API? - PullRequest
0 голосов
/ 22 октября 2018

Я пытаюсь создать прототип (используя Grails 2), в котором мы используем преимущества Swagger для нашей документации.

Таким образом, я включил в наш BuildConfig.groovy следующее:

compile "io.swagger:swagger-core:1.5.3"
compile "io.swagger:swagger-jaxrs:1.5.3"  

И затем я объявил bean-компонент в resources.groovy, используя класс BeanConfig, предоставленный вышеуказанными зависимостями.,И наконец, я только что использовал различные аннотации, предоставляемые зависимостью jaxrs, для документирования контроллеров и их методов.

Все было замечательно, пока я не понял, что это более старые версии чванства (как, например, в OAS 3).Я полностью озадачен тем, как использовать новые библиотеки.

Просматривая документацию, я могу добавить такие зависимости в resources.groovy:

compile "io.swagger.core.v3:swagger-core:2.0.5"  

Но я понятия не имею, какой класс я могу использовать для инициализации сваггера.Где я определил, какие пакеты нужно сканировать?Какой класс я могу использовать для генерации чванства JSON?

Я понимаю, что есть плагины (например, swaggydoc), но они не поддерживаются, и поэтому я бы не стал их использовать.
В идеале, я бы использовал библиотеки, предоставляемые самим swagger.

Это всего лишь Java-код, и поэтому я чувствую, что должен быть в состоянии интегрировать его с Grails 2, тем более что он работал со старыми библиотеками Swagger.Но мне нужна помощь, чтобы начать.

...