OpenAPI 规范详解
该 OpenAPI 规范 是关于此 API 描述格式的终极知识来源。但是,对于新手来说,它的长度令人生畏,并且对于经验丰富的用户来说,很难找到特定的信息片段。本章为不熟悉 OpenAPI 的读者提供了一个软着陆,并按主题组织,简化了浏览。
以下页面介绍了 OpenAPI 描述(OAD)的语法和结构,其主要构建块和最小的 API 描述。之后,将详细介绍不同的块,从最常见的块开始,逐步过渡到高级块。
- OpenAPI 描述的结构: JSON、YAML、
openapi
和info
- API 端点:
paths
和responses
。 - 消息体的內容:
content
和schema
。 - 操作的参数和有效负载:
parameters
和requestBody
。 - 重复使用描述:
components
和$ref
。 - 提供文档和示例:
description
和example
/examples
。 - API 服务器:
servers
。