OpenAPI 规范

OpenAPI规范是Linux基金会协作项目OpenAPI Initiative中的社区驱动的开放规范。

OpenAPI规范（OAS）为HTTP API定义了标准的，与编程语言无关的接口描述，它允许人类和计算机发现和理解服务的功能，而无需访问源代码，其他文档或检查网络流量。当通过 OpenAPI 正确定义时，使用者可以使用最少的实现逻辑来理解远程服务并与之交互。与接口描述对较低级别编程所做的类似，OpenAPI规范消除了调用服务时的猜测。

机器可读API定义文档的用例包括但不限于：交互式文档;文档、客户端和服务器的代码生成;和测试用例的自动化。OpenAPI 文档描述了 API 服务，并以 YAML 或 JSON 格式表示。这些文档可以静态生成和服务，也可以从应用程序动态生成。

OpenAPI 规范不需要重写现有的 API。它不需要将任何软件绑定到服务上 - 所描述的服务甚至可能不归其描述的创建者所有。但是，它确实要求在OpenAPI规范的结构中描述服务的功能。并非所有服务都可以由OpenAPI描述 - 此规范并非旨在涵盖HTTP API的所有可能样式，但确实包括对REST API的支持。OpenAPI规范不要求特定的开发过程，例如设计优先或代码优先。它确实通过与HTTP API建立清晰的交互来促进任何一种技术。

这个GitHub项目是OpenAPI的起点。在这里，你将找到有关OpenAPI规范所需的信息，它的外观的简单示例以及有关该项目的一些一般信息。

当前版本 - 3.1.0

OpenAPI规范的当前版本是OpenAPI规范3.1.0。

以前的版本

此存储库还包含所有以前的版本。

此存储库中的每个文件夹（如示例和架构）都应包含与规范的当前版本和以前版本相关的文件夹。

查看实际应用

如果你只想看到它的工作，请查看当前示例列表。

工具和库

想了解如何创建自己的OpenAPI定义，呈现它或以其他方式使用它？查看不断增长的实现列表。

参与

OpenAPI规范的当前开发过程在开发指南中进行了描述。OpenAPI规范下一版的开发由技术指导委员会（TSC）指导。这组提交者带来了他们的API专业知识，纳入了来自社区的反馈，并适当地扩大了提交者组。未来规范的所有开发活动都将作为功能执行并合并到此分支中。在发布未来的规范时，此分支将合并到 。

main

TSC每周举行一次网络会议，审查开放拉取请求，并讨论与不断发展的OpenAPI规范相关的开放问题。参加每周电话会议和预定的工作会议向社区开放。你可以在线查看整个 OpenAPI 技术会议日历。

OpenAPI倡议鼓励个人和公司的参与。如果你想参与 OpenAPI 规范的演进，请考虑执行以下操作：

• 查看当前规范。人类可读的降价文件是规范的真实来源。
• 查看开发过程，以便了解规范是如何演变的。
• 检查问题和拉取请求，看看是否有人已经记录了你的想法或对规范的反馈。你可以通过订阅现有问题或 PR 来关注现有对话。
• 通过 CodeTriage.com 在收件箱中订阅一天（或一周）未结期刊。
• 创建问题以描述新关注点。如果可能，请提出解决方案。

并非所有的反馈都可以被容纳，并且可能有坚实的论据支持或反对适合规范的更改。

发 牌

请参见： 许可证 （Apache-2.0）