Как опубликовать Javadoc вместо страницы index.jsp для веб-службы REST - PullRequest
1 голос
/ 31 января 2011

Мне было интересно, возможно ли, чтобы клиент нажал на мой веб-сервис, и вместо того, чтобы он показывал обычную страницу index.jsp (и перечислил, что доступно и т. Д. Здесь), я мог бы вместо этого показать ей javadocs из методов, доступных через веб-сервис. Я довольно новичок в REST / webservices в целом, но я использую myeclipse, и я знаю, что в настоящее время он обращается к странице index.jsp через файл web.xml, например:

<welcome-file-list>  
<welcome-file>index.jsp</welcome-file>  
</welcome-file-list>

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

Буду признателен за любую помощь, и если потребуется больше ясности / информации, я буду рад добавить ее. Спасибо.

редактировать:

В итоге я просто экспортировал как javadoc и выбрал только нужные мне файлы / только публичные методы. Затем поместил созданную папку с документами в webroot и отредактировал файл web.xml в

<welcome-file-list>  
<welcome-file>index.html</welcome-file>  
</welcome-file-list>

и поместил <FRAME src="doc/ перед обычным путем в index.html, а также Link to<A HREF="doc/, чтобы он мог выполнять поиск относительно папки doc, а не webroot.

Ответы [ 2 ]

1 голос
/ 31 января 2011

Если вы сгенерируете javadoc для всех своих страниц (для этого есть отличные инструменты, даже интегрированные в систему сборки maven), вы можете легко отобразить эти страницы непосредственно в свое веб-приложение. Таким образом, вместо отображения вашего index.jsp, вы отображаете index.html из сгенерированных javadocs.

0 голосов
/ 31 января 2011

Не уверен насчет Javadocs, но вы рассматривали файл WADL для описания своих услуг?

Если вы используете Джерси, эта статья может помочь:

http://wikis.sun.com/display/Jersey/HowToConfigureExtendedWADL

...