rest - OpenAPI 规范以外的规范来记录一个 RESTful API

Question

首先要对 OpenAPI 规范本身有个清晰的认识，我们来看看它的官网（https://github.com/OAI/OpenAPI-Specification）是如何定义的：

OpenAPI 规范的目标是为 REST API 定义一个与语言无关的标准接口，它允许人类和计算机在无需访问源代码、文档或通过网络流量检查的情况下发现和理解服务的功能

问： OpenAPI 定义了一个关于如何用 YAML 或 JSON 编写 API 文档的规范。现在问题出现了，如果它是完成这项工作的唯一规范吗？还是有其他相同的选择？

我在网上查了资料，但没有得出任何结论。

---

注意：这个问题可能会被问到软件推荐，但由于“规范”不能称为“软件”，我决定在 stackoverflow 上问它。

Answer 1

我参加了 Pluralsight 的在线课程，即构建 REST API 的五个基本工具，并且可以找到以下两个工具作为 OpenAPI 规范的替代品：

• RAML ( http://raml.org/ )
• API 蓝图 ( https://apiblueprint.org/ )

这是 OpenAPI 规范的两个替代方案，并且在某种程度上它们的规范更新和丰富。但是，由于它们非常新，因此并没有得到组织的认可，并且工具支持有限。他们目前支持的大多数工具都是基于云的。