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

时间:2011-01-31 16:48:28

标签: java eclipse rest javadoc jax-rs

我想知道客户端是否有可能点击我的web服务而不是显示正常的index.jsp页面(并在此处列出可用的内容等)我可以让它显示来自可用方法的javadocs网络服务。我对REST / webservices一般都很陌生,但我使用的是myeclipse,我知道目前它正在通过web.xml文件访问index.jsp页面,如下所示:

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

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

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

编辑

我最后只是导出为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进行搜索。

2 个答案:

答案 0 :(得分:1)

如果您为所有页面生成javadoc(有很好的工具可以执行此操作,甚至可以集成到maven构建系统中),您可以轻松地将这些页面直接映射到您的Web应用程序中。因此,不显示index.jsp,而是从生成的javadocs中显示index.html。

答案 1 :(得分:0)

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

如果你正在使用泽西岛,那么这篇文章可能有所帮助:

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