一、swagger.json结构
通过浏览器打开示例url:petstore.swagger.io/v2/swagger.…,打开F12进入调试模式,找到Network查看all下面的所有请求。找到swagger.json点击Preview就可以看到一个json结构的api文档。
先一一解释一下json的内容
basePath:前端接口请求的通用前缀;
definitions:用于保存操作生成和使用的数据类型的对象。就是后台返回的对象。包括请求对象和返回对象;
externalDocs:一些额外的信息。
host:为API提供服务的主机(名称或ip);前端接口请求的地址。
info:API相关信息。
paths:API的路径。
schemes:操作的传输协议。
securityDefinitions:可在整个API规范中使用的安全方案定义。
swagger:swagger的版本。
tags:分类的标记列表。
二、通过具体示例了解上面参数的意义。
打开url:petstore.swagger.io/,首先看到的就是Baseurl和swagger.json地址
然后下面可以看到支持的协议schemes;再下面就是所有的请求url.可以看到url是以swagger.json里面的tag进行的分类。所有接口分为3类,pest,store,和user,最后是Models
所有的models解析的是swagger.json 里面definitions这个对象。
找到Pest下面的第4个url接口
然后找到对应path结构。
点击Parameters选择pengding.然后点击Execute。可以看到浏览器发送了一个get请求petstore.swagger.io/v2/pet/find…
首先请求的url;就是前面swagger.json结构里面的host+basePath+对应的path;请求参数status=pending就是path结构里面的parameters;而接口的返回结果就是看path结果里面的
responses。
通过上面的解析就发现。通过一个swagger.json文件就可以直接知道一个接口的请求方式、请求url、请求参数、以及请求返回结果。那么我们也正好可以用这样一个json文件生成我们所需要的api文件。