所以一定要注重用户的需求, 而不要让内部实现细节, 原理什么的来骚扰用户. 最后再次强调, 要设计出让用户容易理解和容易使用的API.
所以 API 就是用户看到的, 它表示出用户能使用它做什么....一个Action可能有多种响应结果, 每种可能的响应结果都要在responses属性中描述.
每个响应都以状态码进行标识, 并且必须包含一个description属性....这里 parameters属性是一个集合或数组, 每个集合元素使用 - 开头.
为了描述一个参数, 至少需要name, in 和 schema 三个属性....这里面name的值必须和 {} 里面的值一样.
in 的值为 path, 表示是路径参数.
路径参数是必填的, 所以 required 为 true. 不然解析器会报错....JSON引用这个属性的名字是$ref, 它的值是一个URL. 这个URL可指向本文档内部甚至外部的组件. 这里我只引用文档内部的组件.
?
