它包含很多东西, 例如如何使用API, 文档, 技术支持等等, 但是最重要的还是API的设计. 如果 API 设计的不好, 那么使用该API构建的软件就需要增加在时间,人力,金钱等方面的投入....针对REST而言, OpenAPI Specification(OAS) 就是一个非常流行API描述格式规范.
OAS
API描述格式是一种数据格式, 它的目标就是描述API....Swagger 规范最后的2.0版本就变成了 OpenAPI 2.0. 目前最新的OAS 应该是3.0大版本
YAML
OAS文档可以使用YAML或JSON格式, 我使用YAML....而针对那个 get Action的返回结果(数组类型), 需要把JSON引用放在 array 的 items属性里.
可复用参数
直接看代码:
?...和可复用schema类似, 可复用参数也放在components下面, 它所在的区域是 parameters. 其引用方式也类似, 就不过多介绍了.