什么是 API 设计
API 是软件系统 中各个组件间的沟通接口, 设计 API 就是在设计组件间接口.
在设计时需要明确:
- 这个 API 是做什么的
- 它的目标用户
- 它对应的资源
- 资源的 URI
- 使用什么 action 操作资源
- 它的输入输出
什么是 OAS?
OAS 是一个独立于编程语言的 RESTful API 描述语言, 可以通过 JSON 或 YAML 来编写. 推荐使用 YAML, 更紧凑和简洁, 更易读.
它的定位是用于描述实际 API, 在 API 的目标明确后, 通过它来描述该 API.
使用 OAS 编写的示例详见: 示例