Инструмент, похожий на javadoc, для документации по api spring-mvc rest? [закрыто]

Закрыт. Этот вопрос не по теме . В настоящее время он не принимает ответы.

Хотите улучшить этот вопрос? Обновите вопрос , чтобы он был по теме для Stack Overflow.

Закрыт 7 лет назад .

Я искал javadoc-подобный инструмент документации REST API . Я уже задокументировал свои контроллеры отдыха в javadoc, и я думаю, было бы неплохо просто создать на его основе API-документацию для интерфейсных разработчиков.

Я думаю, что пока нет инструмента. Так у кого-то есть идеи, как выполнить эту задачу? Я подумал об использовании классического инструмента javadoc и добавлении некоторой специальной логики для пружин / отдыха . Но я еще не уверен, нужна ли мне еще какая-то специальная разметка или какие могут быть подводные камни. В конце концов, мне бы хотелось иметь какой-нибудь инструмент, который можно интегрировать в жизненный цикл сайта maven , но это не должно быть сложно выполнить.

Может быть сложно обрабатывать наследование: я использую его много ресурсов REST, но для читателя наследование - это не то, о чем он должен заботиться. Таким образом, субконтроллеры должны каким-то образом интегрировать методы суперконтроллеров, но также иметь возможность создавать значимую документацию в контексте фактического контроллера. Я не уверен, что Spring позволяет мне перезаписывать методы из суперконтроллеров, но все же оценивает его аннотации.

Я был бы признателен за любые подсказки по связанным проектам, инструментам, которые уже существуют, или просто вашему опыту работы с инструментом javadoc!

задан Jan 22 November 2010 в 10:37

0 ответов

Другие вопросы по тегам:

java spring api rest javadoc

Инструмент, похожий на javadoc, для документации по api spring-mvc rest? [закрыто]

0 ответов

Похожие вопросы: