目录
文章目录
OpenAPI Specification
Swagger Specification 是一种 API Specification(API 规范),2015 年,SmartBear Software 将 Swagger Specification 捐赠给 Linux Foundation,并改称为 OpenAPI Specification,简称(OAS)。SmartBearSoftware 也作为 OpenAPI Initiative(OAI)的创始成员,该机构以开放和透明的方式管理 OAS 的发展。
OpenAPI Specification 本质上是一种 RESTful API 的 API Description Format(描述格式),允许用户用于描述整个 API。OpenAPI 规范可以用 YAML 或 JSON 编写,包括:
- 每个 API 的可用端点(e.g. /users)和操作(e.g. GET /users,POST /users)。
- 操作参数每个操作的输入和输出。
- 认证方式。<