共计 965 个字符，预计需要花费 3 分钟才能阅读完成。
OpenAPI 接口标准
OpenAPI 是形容 HTTP API 的规范形式。明天来讲讲它的接口标准（OpenAPI 标准 (中文版)）~
OpenAPI 版本号标准
OpenAPI 的版本号是应用 major.minor.patch 格局来定义的，比方 3.1.2
- major： 规定大版本
- minor： 规定小版本
- patch： 规定小版本中的修补
OpenAPI 格局标准
OpenAPI 能够应用 JSON 或 YAML 的格局，且字段辨别大小写：
JSON 示例
YAML 示例
OpenAPI 文档构造标准
OpenAPI 文档能够是单个文档，也能够多个文档，由你们团队自行决定。在后一种状况，须要在 Reference Objects 和 Schema Object 中应用 $ref 关键字。
而文档的命名，倡议命名为 openapi.json 或 openapi.yaml。
OpenAPI 数据类型标准
OpenAPI 的数据类型，必须合乎 JSON Schema Specification Draft 2020-12 的标准才行
JSON Schema 标准地址：https://datatracker.ietf.org/doc/html/draft-bhutton-json-sche…
OpenAPI 富文本格式标准
OpenAPI 的 description 字段是反对 CommonMark markdown 格局的，所以在 OpenAPI 中应用富文本，格局必须合乎 CommonMark markdown 格局。
OpenAPI 对象
Info Object
形容 API 的元数据
Contact Object
API 的分割信息
Server Object
API 的服务器对象信息
能够是一个服务器
也能够是多个服务器
Components Object
API 的可复用组件对象
Paths Object
形容 API 的 URL 的对象
Path Item Object
单个门路上可用操作的对象
Operation Object
门路上单个 API 操作的对象
External Documentation Object
拓展内部资源
Parameter Object
参数对象
Request Body Object
单个申请 Body 的对象
Responses Object
API 返回响应的对象
Header Object
申请头的对象
常识扩大：
- 了解 Swagger 和 OpenAPI：API 设计和文档化的最佳实际
- OpenAPI 入门指南
正文完
