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

Rem*_*anu 8 rest wsdl web-services wadl

我看到的大多数REST接口都是用一个描述URL,方法,接受的输入和返回结果的简单网页来描述的.例如Amazon S3Twitter API文档.

人类可读对于亚马逊或Twitter来说显然已经足够好了.但是有没有公司以机器可读的格式描述REST API?如果是的话,哪些?

WSDL 2.0声明能够描述REST.显式创建WADL用于描述REST服务.WSDL 2.0和WADL似乎都有一个相当小的跟随atm,它似乎是创建和维护描述文档的努力的回报.通过识别现实生活中的例子,基本上可以验证或否定这一假设.

您是否使用WSDL/WADL来描述您的服务?您是否依赖WSDL/WADL来消费他人的服务?您的选择工具目前是否支持?是否有可以使用的广泛使用的REST服务示例,这些示例以机器可读格式详细说明?

dim*_*mus 1

以下仅是我个人的看法:

我认为 WADL 类似于 html 页面的站点地图。站点地图在理论上被认为是一种很好的做法,但很少实施,更很少被人们使用。

我认为原因很简单 - 在网站上闲逛并按策略性放置的按钮通常比浏览复杂的地图更有价值。

REST API 方法不应需要正式描述。因此,如果 API 是经过深思熟虑创建的,那么只需遵循策略性放置的“主”RESTful 资源的 uri 链接,就可以很容易地发现所有资源。

  • 你的回答在精神上是正确的。正如您所描述的,REST 接口应该是可发现的。然而,表示使用的所有媒体类型都应该有正式的定义。REST 并不是避免记录 API 的借口。区别在于您所记录的内容。请记录客户端和服务器之间流动的数据结构,而不是端点(即 URL)。 (8认同)