如果不这样分解到话, 通常设计出的API会缺失一些目标.
针对1, 也解释一下
首先应该识别出不同种类的用户, 这里的用户可能是人, 也可能是其他的程序....Swagger 规范最后的2.0版本就变成了 OpenAPI 2.0. 目前最新的OAS 应该是3.0大版本
YAML
OAS文档可以使用YAML或JSON格式, 我使用YAML....生成代码
使用API描述格式进行描述的API, 其代码也可以部分生成. 通常是一个代码骨架.
什么时候使用API描述格式
肯定是在设计接口如何表达API目标和概念, 以及数据的时候....使用OpenAPI 和 JSON Schema 来描述 API 的数据
OAS 依赖于 JSON Schema 标准来对所有的数据(查询参数, body 参数, 响应body等)进行描述....描述查询参数
如果我们的get操作里需要一些查询参数(查询字符串, Query String), 那么可以使用 parameters 这个属性:
?