最强PostMan使⽤教程(6)-使⽤Postman导⼊swaggerOPENAPI 好久没有更新这个系列的⽂章了,最近使⽤postman去测试交易所的API接⼝,让我们继续吧, ?
⽂章⽬录
什么是swagger
先来普及⼀波与swagger相关的基本信息:
Swagger官⽹:
GitHub地址:
官⽅注解⽂档:
Swagger-UI地址:
Swagger简介
Swagger: A Powerful Interface to your API
“Swagger是⼀个规范和完整的框架,⽤于⽣成、描述、调⽤和可视化RESTful风格的Web服务。”简单来说,Swagger是⼀个功能强⼤的接⼝管理⼯具,并且提供了多种编程语⾔的前后端分离解决⽅案。Swagger主要包含了以下4个部分:
1. Swagger可以直接嵌⼊项⽬中,通过开发时编写注释,⾃动⽣成接⼝⽂档;
2. Swagger包含了Swagger
Editor,它是使⽤yaml语⾔的Swagger API的编辑器,⽀持导出yaml和json格式的接⼝⽂件;
3. Swagger包含了Swagger
UI,它将Swagger Editor编辑好的接⼝⽂档以html的形式展⽰出来;
4. Swagger⽀持根据定义的接⼝导出各种语⾔的服务端或客户端代码。
其中1和4是更加⾯向开发的内容,开发团队要有⾃动⽣成⽂档的需求,在开发和⾃测中遵循前后端分离。⽽2和3是相对可以独⽴出来的、可供QA⼈员参考的接⼝⽂档管理⽅案,也是我们主要关注的部分。
Swagger提供了Swagger
Editor和Swagger UI的在线demo,如下图。可以看出,Swagger可以完整地定义⼀个接⼝的内容,包括各个参数、返回值的具体结构、类型,Swagger
Editor可以实时进⾏编辑并在线调试。编辑好的API可以导出为json⽂件,使⽤Swagger UI打开即可以看到更美观的接⼝⽂档。
postman在线测试Swagger Editor和SwaggerUI的本地部署⼗分简单,这两者都可以直接从Github上下载源码,将其部署到本地Tomcat服务器上,然后通过浏览器访问即可。官⽅还提供了其他⼏种部署⽅式,具体步骤在帮助⽂档中有详细说明,这⾥不再赘述。
为什么需要postman
可以看到swagger本⾝是⼀套完备的框架,即可⾯向开发也可⾯向⽤户, 功能已经很强⼤,那在什么情况下我们需要postman与swagger⼀起⼯作?
对我来说,主要原因如下:
Swagger毕竟是⽹页打开,很多参数⽆法保存,⽽postman可以存储或者动态⽣成测试的参数,⽐如,设计到token权限的
话,swagger中可能每次都需要模拟登录,⽽postman在Header中保存Token信息;如果需要数字签名,postman还可动态的⽣成数字签名
很多交易所的服务器都搭在,访问很慢,但他们⼤抵都提供了swagger接⼝的json,因此,通过将其导⼊到postman,我们可以在本地进⾏接⼝学习和测试,⽆需反复登陆swagger UI
启动postman⽐启动swagger UI⽅便
导⼊
导⼊的⽅式很简单。
获取对应的swagger⽂档的地址或者内容
打开postman的import功能
输⼊链接或者内容
对应的接⼝,⽂档描述,和参数都给你配置好了
因为也是使⽤{{}}, 可以直接对应到postman的variables 修改SWAGGER接⼝
但并⾮所有的swagger.json都能满⾜我们的测试需求,⽐如:
这⾥并没有给我们提供实际的地址,⽽且也不是http,因此,可以修改swagger⽂件,重新导⼊:
修改变量并测试
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论