Метаданные конечной точки REST в Java

Question

Все Я ищу какой-то метод, чтобы показать информацию метаданных о веб-сервисе RESTful, например операции, параметры и так далее. Ты знаешь кого-нибудь?

Answer 1

Пакет jax-doclets может генерировать javadoc-подобную документацию из ваших аннотаций JAX-RS или JAXB.

http://www.lunatech -labs.com / open-source / jax-doclets

В наших проектах мы в настоящее время создаем документацию вручную, но мы начинаем оценивать этот инструмент.

Answer 2

Некоторые остальные конечные точки поддерживают WADL.

WADL для REST аналогичен WSDL для JAX-WS (SOAP).

Подробнее о wadl можно узнать по адресу: http://wadl.java.net/ (включая ссылку на спецификацию).

Jersey (http://jersey.java.net) - это эталонная реализация Oracles JSR-311 Reference, а также некоторые дополнительные функции, такие как автоматическая генерация WADL, которая была недавно улучшена (версия 1.9) - она ​​включает в себя схему XSD для передаваемых типов (которую можно использовать) для гораздо лучшей генерации клиентского кода).

В общем, если вы хотите использовать какой-то стандарт, используйте WADL и не изобретайте колесо заново.

Answer 3

Я слышал, что HTML популярен для представления метаданных конечной точки.У вас есть ссылки на ссылки, у вас есть формы для полезных нагрузок, много места для английского текста, чтобы объяснить вещи, формат хорошо документирован с хорошо известной моделью обработки.

Answer 4

Одним из популярных решений является использование Atom и AtomPub