java中的REST端点元数据

Question

所有 我正在寻找一些方法来显示有关RESTful webservice的元数据信息， 例如操作，参数等。 你知道吗？

Answer 1

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

Answer 2

一些休息端点支持WADL。

WADL到REST与WSDL到JAX-WS（SOAP）类似。

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

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

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

Answer 3

我听说HTML很受欢迎，用于表示端点元数据。你有链接引用，你有有效载荷的表格，有很多空间供英文文本解释，格式是用一个众所周知的处理模型记录的。

Answer 4

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

http://www.lunatech-labs.com/open-source/jax-doclets

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