2016-02-29 5 views
3

Мы создадим проект Grails 3, представляющий REST JSON API с помощью контроллеров Grails.Как создать документацию для JSON API с помощью Grails3

Есть ли способ сгенерировать документацию API для REST API, используя аннотации или любую другую управляемую форму, которая будет соответствовать нашей разработке? Другими словами, нам нужен способ автоматически генерировать документацию API в синхронизации с изменениями действий контроллера и параметров/возвращенных объектов.

Мы рассмотрели Swagger и некоторые подобные проекты, но нам не удалось найти способ интеграции документооборота в наш процесс разработки Grails 3 REST API. До сих пор мы нашли те действительно перспективные проекты, которые могли бы помочь нам, но мы не нашли какой-либо способ интеграции в Grails 3:

+0

ли вы посмотрите на плагин Grails Swagger? Была ли причина, которая не сработала для вас? http://rahulsom.github.io/swaggydoc/ – Charlie

+0

hello @Charlie, этот плагин совместим с Grails3? – tmanolatos

ответ

2

Эта библиотека выглядит как самый популярный выбор для Grails 3:

https://github.com/rahulsom/swaggydoc

Вы можете видеть из-за проблем, с которыми некоторые люди добились успеха в работе с 3.x, но, как и в любом проекте с открытым исходным кодом, ваш размер может отличаться.

https://github.com/rahulsom/swaggydoc/issues

 Смежные вопросы

  • Нет связанных вопросов^_^