Существуют ли javadoc-подобные инструменты для генерации веб-службы RESTful apidoc из аннотаций JAX-RS?

Я разрабатываю веб-сервис с CXF, используя аннотации JAX-RS для ресурсов. Эти аннотации указывают имена аргументов, значения по умолчанию и допустимые типы ввода и вывода.

Было бы неплохо запустить javadoc-esque-инструмент в моем коде для создания краткого набора документации этого интерфейса, но я не могу найти ничего.

Документы, созданные самим javadoc, потребуют слишком много обрезки, я действительно хочу что-то, что понимает семантику аннотаций JAX-RS и генерирует что-то дружелюбное к разработчикам, которые хотят использовать мою службу.

Ответ 1

Если вы создаете Restful webservices, документация известна как WADL. WADL - это в основном Rest-версия WSDL. Я использую Jersey для создания моих полезных веб-сервисов. Джерси автоматически создает WADL на основе аннотаций, которые у вас есть в вашем пакете ресурсов. Вот как выглядит образец WADL с сайта Джерси: https://java.net/projects/jersey/sources/svn/show/trunk/jersey/samples/generate-wadl

Лучшая часть этого вы абсолютно ничего не делаете.:) Когда вы изменяете аннотацию URI или параметров в своих классах Resource, они будут автоматически отражены в этой документации.

TADAA!:)

Ответ 2

Посмотрите Enunciate. Там плагин Maven, который будет генерировать документы, включенные в сайт.