postman json 中写注释_Swagger界面丑、功能弱怎么破?用Postman增强下就给力了!
在使用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最佳实践!
欢迎关注,点个在看
postman json 中写注释_Swagger界面丑、功能弱怎么破?用Postman增强下就给力了!相关推荐
- 在Postman json中写注释的方法
文章目录 场景 解决方法 场景 使用Postman调POST接口,请求体json格式中有些字段不能重复,想加入注释方便下次调用前修改. 解决方法 添加冗余_{key}.comment标明注释,实现在j ...
- [译] 代码中添加注释之好坏丑
原文地址:Putting comments in code: the good, the bad, and the ugly. 原文作者:Bill Sourour 译文出自:掘金翻译计划 译者: ba ...
- php json注释,【部分解决】Json中添加注释
[问题] 通过json文件给python脚本传递参数,但是希望每个参数都有对应的注释,以方便使用者知道该参数的确切含义. 问题转化为给json中添加注释. [解决过程] 1.网上找了json的官网JS ...
- Mybatis - xml文件标签中写注释
Mybatis - xml文件标签中写注释 1.错误场景. ( /* */ 注释 ) 在IDEA中的直接使用快捷键注释 Ctrl + Shift + / 注释. SELECT t.name, t.ag ...
- html 中写注释吗,html 注释
一.html 注释语法 - TOP 使用解释:在html中,小于符号"",注意这些字符都需要英文半角小写输入. 二.html注释作用 - TOP 在html中使用注 ...
- vscode json文件中写注释
1.在vscode 打开一个json文件,点击底部的 JSON with Comments 选择语言模式 2.搜索 com 注意:上述方法重启vscode可能会失效,在设置中添加如下配置 // 配置文 ...
- html 中写注释吗,html怎么注释?
html怎么注释?html若何注释?html注释方法是什么? 在HTML代码中为了以后便于极快查找哪部分代码是什么劝化,是哪块结构的代码?想在代码中加说明翰墨,又不想影响网页机关(涉猎器滤掉不读取). ...
- java api帮助文档_JAVA的Swagger界面丑、功能弱怎么破?
在做CRMEB-JAVA开源商城系统时,我们团队用到了uni-app,也是时下比较流行的移动端开发技术,这里边就牵扯到了前后端全部分离的问题,一般在使用java开发前后端分离项目的时候,都会用到Swa ...
- python如何注释一段代码_Python 中如何写注释
在写 Python 代码的时候,一个很好的编码实践就是使得你的代码简洁,易懂.组织代码,设置变量,以及给函数有意义的名字,都是几个不错的方法. 另外一个提高代码可读性的方式就是使用注释.一个注释就是可 ...
最新文章
- linux监控平台搭建-内存
- pdf.js 使用实例
- openssl passwd之openssl命令详解
- QQ协议分析及其还原(二)
- svchost.exe介绍
- LogSegment分析
- XX证券 机器学习平台使用情况访谈总结
- ARX帮助文档:数据库对象
- 职场泥潭,这样的IT公司绝对不宜久留
- 功能测试Ⅲ——缺陷及缺陷管理
- 概述-数据建模是什么?
- proftpd java_基于 proftpd 配置加密 FTP
- Excel学习之旅(三)
- 一台计算机连接两个投影,事实:如何将两个外接显示器连接到笔记本电脑以同时实现三个屏幕?...
- Mac平台配置OpenGL(glut,glew)
- 【调剂】2021年南昌航空大学无损检测技术教育部重点实验室卢超教授团队招优秀调剂研究生...
- AMEYA360皇华:电子元器件四大分类
- Matlab图像噪声处理
- 软考复习笔记、项目论证与评估与项目招投标流程及管理,建议收藏
- 基于JAVA直播购物平台计算机毕业设计源码+系统+lw文档+部署
热门文章
- HDU 2154:跳舞毯
- 安卓Service完全解析(中)
- jquery01-简介+语法+选择器+事件
- 虚幻引擎自带的创建插件的插件
- 正则表达式学习(2)
- Java Web(十) JDBC的增删改查,C3P0等连接池,dbutils框架的使用
- Tomcat 指定jdk
- 基于visual Studio2013解决面试题之1102合并字符串
- centos 低版本出现fatal: unable to access 'https://github.com/XXXX': SSL connect error
- Power Query获取整理多来源数据