关于java:Swagger界面丑功能弱怎么破用Postman增强下就给力了

在应用 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！