Swagger

Swagger

参考文档：https://www.gitbook.com/book/huangwenchao/swagger/details

1、 作为web API，一个很重要的信息就是用来给消费者使用的根URL，可以用协议（http或者https）、主机名、根路径来描述：

                       

消费者把https://simple.api/open101作为根节点来访问各种API

2、 在每个路径中，我们可以添加任意的HTTP动词来操作所需要的资源。

3、 对于每个方法（或操作），我们都可以在响应(responses)中添加任意的HTTP状态码

4、 通过响应消息中的模式（schema）属性来描述清楚具体的返回内容。

5、 请求参数：in: query

路径参数：in: path

Post的参数：in: body

6、 路径参数添加到 parameters 属性中时，注意名称应该同上面大括号（ { } ） 里面的名称一致

7、 如果没有写 require 属性，默认值是 false

8、 如果查无此人，应该返回 404 的异常状态

9、 当我们需要添加一个用户信息时，我们需要一个能够提供 post /persons 的API操作

10、            给 post 方法添加参数，通过 in 属性显式说明参数是在 body 中的

11、            不仅仅在消息中可以使用定义，在参数中也可以使用。

12、            可重用的响应消息、参数定义、

13、