Создание интерактивных Rest API документация от Явы

Глядя на Swagger и друзей я до сих пор не удалось найти правильный подход к полностью автоматизированной & интерактивного API генерации документацииСоздание интерактивных Rest API документация от Явы

требования:

синтаксического анализа Java Doc комментариев в java classes
анализировать java-аннотации в классах Java (для документирования ролей, разрешений или исключений из документации)
позволяет добавить подробный пример запроса api (домен hasto be конфигурируемые)
может быть вызвано Maven или Дженкинс

результат:

полностью автоматически документации с рабочим образцом запросов для каждого метода API

Я знаю его много, котор нужно попросить для. Кто-нибудь когда-либо приблизился к этому, не написав собственный парсер?

источник

2015-02-13 zbug

Вы можете попробовать посмотреть Enunciate, у них есть модуль Swagger.

Swagger-core является библиотека времени выполнения и поэтому не может обращаться к документам javadocs. swagger-maven-pluginможет позволяет вам это делать, хотя он полагается на чванство.

источник

2015-02-16 21:15:43 Ron

спасибо я дам ему попробовать и отчитаться – zbug

+1 за ссылку излагает , Кажется, это хорошее начало. Однако я забыл упомянуть, что мы используем JSON-RPC, поэтому у нас есть только одна конечная точка для запросов POST, которые мы используем для сотен методов API. Если кто-то знает надежный способ создания интерактивных документов JSON-RPC API, пожалуйста, дайте мне знать. – zbug

(Отказ от ответственности: я являюсь разработчиком на MireDot.)

Вы можете проверить бесплатную версию MireDot. Хотя на данный момент мы еще не поддерживаем примеры полного API-запроса (это планируется для более поздней версии), он предлагает подробную документацию тела запроса/ответа. Кроме того, он предлагает именно то, что вы хотите, with a minimum of configuration.

источник

2015-02-18 15:45:35 DenEwout

Я провел пару дней, борясь с Swagger и никогда не смог заставить его работать должным образом, особенно пользовательский интерфейс, который имел всевозможные ошибки JavaScript. Я, наконец, сдался, искал еще один инструмент и приземлился на MireDot. Через полчаса я работал с бесплатной версией, и мой API создал документы, которые я хотел. Есть некоторые ограничения для бесплатной версии, и платная версия кажется немного крутой в цене, но, на мой взгляд, это, безусловно, превосходит Swagger.

(Отказ от ответственности:. В отличие от предыдущей должности, я не являюсь разработчиком с MireDot, или не я никоим образом не связан с ними)

источник

2015-08-26 16:08:08 user2816257

Создание интерактивных Rest API документация от Явы

ответ

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