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

Question

我想知道客户端是否可以访问我的 Web 服务，而不是显示正常的 index.jsp 页面(并列出此处可用的内容等)，我可以让它显示通过 Web 服务可用的方法的 javadoc。一般来说，我对 REST/Web 服务相当陌生，但我正在使用 myeclipse，并且我确实知道当前它正在通过 web.xml 访问 index.jsp 页面。像这样的文件:

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

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

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

编辑:

我最终只是导出为 javadoc 并仅选择我需要的文件/仅选择公共(public)方法。然后将创建的 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。