在整个设计过程中, 必须牢记以用户的视角去设计, 如果以开发者的角度去设计, 那么问题就大了....Swagger 规范最后的2.0版本就变成了 OpenAPI 2.0. 目前最新的OAS 应该是3.0大版本
YAML
OAS文档可以使用YAML或JSON格式, 我使用YAML....第1行是Open API的版本
第4行 info 的 version 是指API的版本, 而info这个版本必须使用双引号括起来, 否则OAS解析器会把它当成数字, 从而导致文档验证失败(因为它的类型应该是字符串...注意, 这里第1行 openapi下面的波浪线表示文档验证失败.
在OAS文档里, 一个操作必须在responses属性里提供至少一个响应:
?...在本例中, 还包含 required 和 description 两个可选的属性.