java中的REST端点元数据答案

【问题标题】：REST endpoint metadata in javajava中的REST端点元数据
【发布时间】：2011-12-03 13:07:01
【问题描述】：

全部我正在寻找一些方法来显示有关 RESTful 网络服务的元数据信息，例如操作、参数等。你知道吗？

【问题讨论】：

【解决方案1】：

一种流行的解决方案是使用Atom and AtomPub

【讨论】：

【解决方案2】：

我听说 HTML 在表示端点元数据方面很受欢迎。你有链接参考，你有有效载荷的表格，有很多英文文本解释的空间，格式用众所周知的处理模型有据可查。

【讨论】：

【解决方案3】：

一些 rest 端点支持 WADL。

WADL 到 REST 类似于 WSDL 到 JAX-WS (SOAP)。

您可以在http://wadl.java.net/ 找到更多关于 wadl 的信息（包括规范链接）。

Jersey (http://jersey.java.net) 是 Oracles JSR-311 参考实现，它还具有一些附加功能，例如自动 WADL 生成，最近（1.9 版）改进了 - 它包括用于传输类型（可用于更好的客户端代码生成）。

一般来说，如果你想使用一些标准，请使用WADL，不要重新发明轮子..

【讨论】：

【解决方案4】：

jax-doclets 包可以从您的 JAX-RS 或 JAXB 注释生成类似 javadoc 的文档。

在我们的项目中，我们目前手动生成文档，但我们正在开始评估这个工具。

【讨论】：