OpenAPI Specification

OpenAPI规范

OpenAPI规范是Linux Foundation协作项目OpenAPI计划中的社区驱动的开放规范。

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规范所需的信息，简单的示例以及有关该项目的一些一般信息。

版本

该存储库包含所有已发布的OpenAPI规范版本的降价来源。有关发行说明和发布候选版本，请参阅“版本”页面。

该存储库中的每个文件夹，例如模式和测试，都应包含与规范的当前和先前版本有关的文件夹。

在行动中看到它

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

工具和库

希望查看如何创建自己的OpenAPI定义，呈现或以其他方式使用它？查看日益增长的实施列表。

参与

当前开发OpenAPI规范的过程在贡献指南中描述。

开发OpenAPI规范的下一个版本由技术指导委员会（TSC）指导。这组提交者带来了他们的API专业知识，结合了社区的反馈，并适当扩展了一组承诺。未来规范的所有开发活动将作为功能进行并合并到该分支中。发布未来规范后，该分支将合并到main 。

TSC举行每周的Web会议，以查看开放请求并讨论与不断发展的OpenAPI规范有关的开放问题。参与每周电话和预定的工作会议向社区开放。您可以在线查看整个OpenAPI技术会议日历。

OpenAPI倡议鼓励个人和公司的参与。如果您想参加OpenAPI规范的演变，请考虑采取以下措施：

• 查看规范的降价来源和权威性真相HTML渲染，包括完整的信用和引用。
• 查看贡献过程，以便您了解规格如何发展。
• 检查讨论，问题并提取请求，以查看某人是否已经记录了您的想法或有关规范的反馈。您可以通过订阅现有问题或PR来关注现有的对话。
• 每天（或一周）在您的收件箱中订阅通过CodetRiage.com订阅一个公开问题。
• 进行讨论来描述一个新的问题，理想情况下，对相关用例的明确解释。

并非所有反馈都可以容纳，并且可能存在扎实的论据，或者反对适合规范的更改。

许可

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