web-services - 机器可读格式的 REST 服务示例

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题？更新问题，以便 editing this post 可以用事实和引用来回答它.

5年前关闭。




Improve this question




我看到的大多数 REST 接口(interface)都是用一个简单的网页描述的，描述了 URL、方法、接受的输入和返回的结果。例如 Amazon S3或 Twitter API文档。

对于亚马逊或 Twitter 来说，人类可读性显然已经足够了。但是，是否有任何公司以机器可读的格式描述 REST API？如果是，是哪些？

WSDL 2.0 声明是 capable of describing REST . WADL是为描述 REST 服务而显式创建的。 WSDL 2.0 和 WADL 似乎都有一个相当小的后续 atm，并且对于创建和维护描述文档的努力似乎没有什么返回。通过识别现实生活中的例子，基本上可以验证或否定这个假设。

您是否使用 WSDL/WADL 来描述您的服务？你是否依赖 WSDL/WADL 来消费别人的服务？您选择的工具目前是否支持其中任何一种？是否有任何可以使用的广泛使用的 REST 服务示例，并以机器可读格式详细说明？

Answer 1

是的你应该。您将能够使用一组支持 WADL 的工具生成您的客户端代码、测试和文档。可以找到一些示例 here .另外，我认为您应该坚持使用 WADL，而不是 WSDL 2.0，因为它不那么冗长且更简单(恕我直言)。事实上，在 WADL 中，您只需使用 WADL XML 语法就可以准确地描述用户在文档页面上看到的内容。顺便说一句，这就是为什么为 WADL 编写基于 XSLT 的文档生成器如此容易的原因。