如何描述restful webService

How to describe restful webService

我知道两种类型的网络服务。

SOAP 网络服务可以用 WSDL 描述。 那么restfulwebservice怎么描述,才能让人知道怎么调用。

我正在处理文档。有没有类似WSDL的东西。

坏消息:

没有正式的方式来记录您所描述的 REST。另请记住,WSDL 用于生成代码工件以及记录服务。

好消息:

不过你可以看看下面四个选项:

  1. WADL:REST 的 WSDL 等价物(未被广泛使用或接受)
  2. RAML:Contender 作为记录 REST 和实现代码的标准方式,即等效的 WSDL。
  3. Swagger:记录 REST 服务。当它第一次出现时并不是真正的 WSDL 等价物。然而,最近这种情况发生了变化。请参阅下面的 OpenAPI。
  4. OpenAPI:基于 Swagger,是一种自上而下设计的方式。

丑闻:

由于没有 "official" 一些客户会喜欢 RAML 而有些客户会喜欢 Swagger 的方法,因此很难满足所有人的需求,但这是次要的一点。