REST端点元数据

Question

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

Answer 1

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

Answer 2

休息端点支持WADL。

WADL到REST是作为WSDL到JAX-WS（SOAP）类似。

你可以找到更多关于WADL：http://wadl.java.net/（包括规格链接）。 （http://jersey.java.net）是一个Oracles JSR-311参考实现，它还具有一些附加功能，如自动WADL生成，最近（版本1.9）得到改进 - 它包括XSD模式用于传输类型（可用于更好的客户端代码生成）。

一般来说，如果你想使用一些标准，请使用WADL，不推倒重来..

Answer 3

我听到HTML是受欢迎的代表终点的元数据。你有链接参考，你有载荷的形式，很大的空间来解释事情的英文文本，这种格式很好地记录了一个众所周知的处理模型。

Answer 4

了JAX-的doclet包可以生成从JAX-RS或JAXB标注类似JavaDoc的文档。

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

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