在应用Swagger的时候，你是否会有这种感觉：提交参数为JSON没法格式化，参数错了查找麻烦，返回后果没法折叠，太长了没法看！Swagger联合Postman应用后这一状况有很大扭转，明天咱们来讲下如何应用Postman加强Swagger的性能，心愿对大家有所帮忙！

SpringBoot实战电商我的项目mall（40k+star）地址：https://github.com/macrozheng/mall

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...

本文 GitHub https://github.com/macrozheng/mall-learning 曾经收录，欢送大家Star！