在使用Swagger的时候,你是否会有这种感觉:提交参数为JSON没法格式化,参数错了查找麻烦,返回结果没法折叠,太长了没法看!Swagger结合Postman使用后这一情况有很大改变,今天我们来讲下如何使用Postman增强Swagger的功能,希望对大家有所帮助!

Postman使用

Postman是一款非常好用的接口调试工具,界面漂亮且功能强大,对Postman不了解的可以看下《Postman:API接口调试利器》。

Swagger结合Postman使用

下面介绍下如何将Swagger API导入到Postman中去,然后使用Postman来调试接口。

Swagger API导入Postman

  • 首先我们需要启动使用了Swagger的应用项目,这里以之前的mall-tiny-swagger项目为例子,找到api-docs路径,访问地址:http://localhost:8088/swagger-ui/

  • 什么是Swagger的api-docs访问路径?该路径会返回JSON格式数据,应用中Swagger渲染API文档页面的所有数据就是来源于此,Postman也是可以通过这些数据来渲染API文档页面,这里的api-docs地址为:http://localhost:8088/v2/api-docs

  • 在postman中点击import按钮,选择Link,输入Swagger的api-docs路径即可将Swagger生成的接口导入到Postman中去了;

  • 直接使用默认选项导入即可,无需修改;

  • 导入成功后,Swagger中的接口就会出现在Postman中了,之后就只需要在Postman中改改参数就可以开始调试接口了,是不是很方便!

Postman设置环境变量

  • 我们随意找个接口访问下,会发现访问出错了,那是因为baseUrl这个环境变量设置有问题,导致了接口无法访问;

  • 我们只要在Postman中设置baseUrl这个环境变量,就可以正常访问了;

  • 添加好环境变量之后,需要选择好环境才会被应用。

访问需要登录认证的接口

  • 这时候再次访问接口会发现我们的接口需要登录认证才能正常访问;

  • 我们可以先调用登录接口来获取Token;

  • 给需要登录认证的接口添加Bearer Token类型的Token,我们可以发现需要配置一个叫token的环境变量;

  • 在环境变量中添加token

  • 添加完环境变量后即可正常访问需要登录认证的接口了。

有何缺点

此种方法使用Postman来调试接口是非常强大的,但是对于文档展示能力有点偏弱。

  • 比如说Swagger中的接口对于请求和返回参数都有非常完善的注释信息;

  • 而在Postman中,这些文档信息得不到体现,Postman毕竟还只是一个接口调试工具。

总结

Swagger和Postman结合使用比较好,Swagger用来看接口文档信息,Postman用于调试,将Swagger中的接口导入到Postman中可以弥补Swagger在接口调试方面的不足。

项目源码地址

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-swagger

推荐阅读

  • 一线城市程序员VS三线城市程序员,该选哪个?

  • IntelliJ IDEA如果这样设置,使用起来贼顺手!

  • 还在百度Docker命令?推荐一套我用起来特顺手的命令!

  • mall-swarm微服务电商系统如何部署?用Jenkins自动化部署是真的香!

  • 看看人家那后端API接口写得,那叫一个优雅!

  • MySQL如何实时同步数据到ES?试试这款阿里开源的神器!

  • 为何程序员上班时间总戴个耳机,看完恍然大悟...

  • 还在手动整合Swagger?Swagger官方Starter是真的香!

  • 40K+Star!Mall电商实战项目开源回忆录!

  • mall-swarm 微服务电商项目发布重大更新,打造Spring Cloud最佳实践!


欢迎关注,点个在看

Swagger界面丑、功能弱怎么破?用Postman增强下就给力了!相关推荐

  1. postman json 中写注释_Swagger界面丑、功能弱怎么破?用Postman增强下就给力了!

    在使用Swagger的时候,你是否会有这种感觉:提交参数为JSON没法格式化,参数错了查找麻烦,返回结果没法折叠,太长了没法看!Swagger结合Postman使用后这一情况有很大改变,今天我们来讲下 ...

  2. java api帮助文档_JAVA的Swagger界面丑、功能弱怎么破?

    在做CRMEB-JAVA开源商城系统时,我们团队用到了uni-app,也是时下比较流行的移动端开发技术,这里边就牵扯到了前后端全部分离的问题,一般在使用java开发前后端分离项目的时候,都会用到Swa ...

  3. swagger 界面_使用Swagger和Scalatra进行界面驱动的开发简介

    swagger 界面 自从三年前开始使用以来,Scalatra网络微框架已经发展成为一个轻量级但功能齐全的模型-视图-控制器(MVC)框架,背后是一个活跃的社区. Scalatra最初是Ruby流行的 ...

  4. 淘宝 APP 网络架构演进与弱网破障实践

    作者:沈良炜 阿里大淘宝终端体验平台团队 面对移动互联网络下复杂多变的网络环境,如何提供更稳定可靠的请求性能,保障用户的加载浏览体验?本文将为大家分享淘宝APP统一网络库的演进. 一.引言 自2013 ...

  5. RDIFramework.NET ━ .NET快速信息化系统开发框架 V3.2-新增模块管理界面导出功能(可按条件导出)...

    RDIFramework.NET ━ .NET快速信息化系统开发框架 V3.2->新增模块管理界面导出功能(可按条件导出) 导出功能在很多应用场景中都需要,RDIFramework.NET V3 ...

  6. (仿头条APP项目)1.app载入界面相关功能实现

    app载入界面相关功能实现 模块功能 1.设置页面布局 2.初始化视频播放 //控制是否跳到主界面private boolean isjump = false;private VideoView vi ...

  7. 肉肉谈对需求设计的想法--到底是功能驱动界面?还是界面驱动功能?

    所有的软件开发无非都离不开那几个阶段第一步:需求调研分析 第二步:概要设计 第三步:详细设计 第四步:编码 第五步:测试 第六步:软件交付准备 其实对于一个程序员来说,最为关心的当然是CODING,但 ...

  8. AX 2009 界面伸缩功能

    界面伸缩功能 在一个界面下,放置多个Grid之后,数据太多,要有个能推拉伸缩的功能,如下图: 中间横条可以上下拉动,折叠处可以关闭显示整个Grid 横条要代码实现,折叠只要设置一下Group就行. 纵 ...

  9. 登录界面及其功能的设计

    登录界面及其功能的设计 实现登录功能,包括如下功能 (1)设计数据库表,包括用户名和密码信息 (2)设计并实现登录界面 (3)实现登录功能,输入正确用户名和密码进入主界面,错误返回登录界面 求代码啊

  10. iphone html5音乐播放器,从界面到功能 五款iPhone音乐播放器年度横评

    前言:音乐播放器应该是目前所有iPhone用户必备的一类App.而作为国内用户而言,在音乐播放器的选择上是很丰富的.比如在目前iPhone客户端上,主流的音乐播放器就有:酷狗音乐.QQ音乐.多米音乐. ...

最新文章

  1. 目标检测数据集The Object Detection Dataset
  2. WPF绘制自定义窗口
  3. html缓存特效代码,HTML特效代码
  4. android用openGl ES绘制任意方程的三维空间图形
  5. ubuntu php 无法执行exec_利用webhook使php项目自动部署
  6. 学习Java编程-Java Timezone类常见问题
  7. 绘制矩形php,php绘制一个矩形的方法
  8. 微信小程序开发学习笔记002--微信小程序框架解密
  9. 山西民生云养老认证人脸识别_民生山西APP公众号手机认证
  10. Oracle 9i所有版本的最新下载地址(已验证!)
  11. Qt:windows下Qt安装教程
  12. idea导出jar包
  13. Exchange 2010安装先决条件及注意事项
  14. 小游戏《堆木头》开发
  15. linux防病毒软件_十大Linux最佳防病毒软件-Linux防病毒软件列表!
  16. Golang 多版本管理
  17. (24)STM32——待机唤醒(低功耗)笔记
  18. 【Python 实战基础】如何绘制树状图展示Python数据分析师的知识结构
  19. mac 隐藏文件(隐藏文件夹)怎么取消隐藏,显示文件(夹)
  20. 超好用的PDF阅读器——Xodo PDF Reader

热门文章

  1. 挑战SQL经典题(一)
  2. 什么是“系统空闲进程”,为什么使用那么多的CPU?
  3. MML ch 10 主成分分析降维(Dimensionality Reduction with Principal Component Analysis)
  4. 【笔记】软件测试04——MySQL
  5. json模块错误:Expecting value: line 1 column 1 (char 0)
  6. malloc、calloc、realloc
  7. 无线网服务器连接不上什么原因,无线路由器连接不上是什么原因
  8. docker访问宿主机127.0.0.1
  9. a标签 vue 动态点击_a链接的href怎么用vue动态生成
  10. 图解阿里达摩院内部结构