如何为REST Web服务发布Javadoc而不是index.jsp页面

Question

我想知道客户端是否有可能打我的Web服务，而不是显示正常的index.jsp页面（并在此处列出可用的内容，等等），我可以让它显示通过Web服务可用的方法中的javadocs。 一般而言，我对REST / webservices还是很陌生，但是我使用的是myeclipse，我确实知道当前它正在通过web.xml文件访问index.jsp页面，如下所示：

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

这样做的主要目的是不必花费大量时间来创建一个欢迎页面，该页面显示可通过我的Web服务使用的每种方法，而可以尝试使其自动化/使其更具可读性。

任何帮助将不胜感激，如果需要更多的清晰度/信息，我会很乐意添加。 谢谢。

编辑：

我最终只是将其导出为javadoc，然后仅选择了我需要的文件/仅选择了公共方法。 然后将创建的doc文件夹放在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搜索。

Answer 1

如果您为所有页面生成一个Javadoc （有很多出色的工具可以做到这一点，甚至可以集成到Maven构建系统中），则可以轻松地将这些页面直接映射到Web应用程序中。 因此，您无需显示index.jsp，而是显示生成的javadocs中的index.html。

Answer 2

不确定Javadocs，但是您是否考虑过WADL文件来描述您的服务？

如果您使用的是Jersey，则本文可能会有所帮助：

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