如何从 REST Web 服务中读取规范答案

【问题标题】：How to read specifications from a REST Web Service如何从 REST Web 服务中读取规范
【发布时间】：2014-12-23 01:17:45
【问题描述】：

我需要创建一个项目来读取其余 Web 服务的规范（合同、文档、信息），它们的方法、返回类型、参数方法等是什么... 但我看到并非所有服务实现类似 WSDL SOAP 的规范。

怎么做？

【问题讨论】：

RESTful Web 服务通常没有规范。他们可能有文档，但这与 SOAP WSDL 不同。
对于刚接触 REST 的人来说，这是一个合理的问题。不值得投反对票。国际海事组织。

标签： java xml json rest wsdl

【解决方案1】：

json-home 格式旨在帮助在运行时发现 API 中可用的资源。还有其他格式，例如 Swagger、WADL、RAML、Api Blueprint，可用于描述 API。但是，为了确保客户端和服务器保持松散耦合，这些规范应该只在运行时使用，而不是在设计时由客户端使用。

【讨论】：

【解决方案2】：

有标准的 WADL，新兴的 RSDL，API 托管设施可以实现自己的文档标准（RAML - Mule，Api Blueprint - apiary.io），并且 Swagger 生成 API 列表。没有每个人都执行的通用标准。如果您的规范要求您能够阅读所有内容，您可以设置优先级并检查每种类型的文档，首先解析首选格式。

如果这些是公司服务，您可以对服务器端进行一些控制，并且可以强制提供者实施易于使用的 WADL 或 swagger（wadl2jave 或 swagger 的 json 列表）。

注意：另一个答案中提到的https://datatracker.ietf.org/doc/html/draft-nottingham-json-home-02 是过期的 IETF 草案。

【讨论】：