Swagger界面丑、功能弱怎么破？用Postman增强下就给力了！

最新推荐文章于 2023-06-21 00:28:36 发布
最新推荐文章于 2023-06-21 00:28:36 发布
阅读量4.4k 收藏 32
点赞数 5
文章标签： java 接口 编程语言 web html
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhenghongcs/article/details/109733525
版权

在使用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

推荐阅读

欢迎关注，点个在看

macrozheng
关注
  • 5
    点赞
  • 踩
  • 32
    收藏
    觉得还不错? 一键收藏
  • 11
    评论
Postman如何做接口测试6：如何使用外部 json 文件数据
分享软件测试技术和学习方法
08-16 5141
在软件测试过程中，你可能已经提前配置了一些环境数据放在通用的配置文件中，你想直接导入这些文件，在 postman 中使用，这样的话，你就不需要重复在 postman 软件中设置了。 比如你可以直接从开发那里得到一个配置文件，里面有 host 地址，数据库地址，每页的列表限制信息，我们能不能把这些数据直接导入到 postman 中使用呢？ 按以下步骤操作。 首先，准备好外部的数据文件，postman 目前支持 csv 格式和 json 格式数据，如果是其他类型的文件，可以先转化成这两种格式。我们以 json
swagger2-to-postman:swagger 2.0 JSON到Postman集合的转换器
04-26
Swagger 2到Postman转换器 将swagger 2.0 JSON转换为Postman Collection v1的转换器 安装依赖项 运行$ npm install安装依赖项 运行NPM测试 运行$ npm test以查看转换器的运行情况 要转换自己的文件吗？ convert.js...
Swagger界面丑、功能弱怎么破？用knife4j增强下就给力了！
CRMEB小程序商城的博客
11-17 1235
在做CRMEB-JAVA开源商城系统时，我们团队用到了uni-app，也是时下比较流行的移动端开发技术，这里边就牵扯到了前后端全部分离的问题，一般在使用java开发前后端分离项目的时候，都会用到Swagger，Swagger 是一个用于生成、描述、调用和可视化 RESTful 风格的 Web api 服务的框架，Swagger 让部署管理和使用功能强大的 API变的简单，但这仅仅是在小型项目里，API接口不多的情况下。 随着，CRMEB-JAVA开源商城系统的不断优化，功能的不断增加，并且前后台都做到了.
是时候扔掉 Postman 了，试试 IntelliJ IDEA 自带的高能神器！
weixin_37097680的博客
11-15 112
点击上方果汁简历，选择“置顶公众号”优质文章，第一时间送达来源：my.oschina.net/keking/blog/3104972前言从邮递员到IDEA REST客户端IDEA R...
Postman与swagger数据交互（导入swagger的json数据）
Anthony路人甲的博客
05-11 1327
Postman与swagger数据交互
vue-swagger-ui:自定义swagger界面
05-02
Vue-Swagger-UI则将Swagger的强大功能与Vue.js的灵活性结合，使得开发人员可以轻松创建符合自己项目需求的定制化Swagger界面。 Vue.js是Google维护的一个轻量级、高性能的前端框架，以其组件化、易学习和强大的生态...
swagger实现接口搜索功能
02-27
功能强大的Swagger，可以通过注解扫描或包体扫描自动生成API文档，可以进行在线文档调试。但是当api接口文档很多时，是不是觉得查找很不方便，官网也没有提供这样的方法，这里修改了swagger的源码，实现了接口搜索的...
Swagger 自定义UI界面.doc
01-09
在本文中，我们将讨论如何使用 Swagger 在 Spring Boot 2.0 项目中自定义 UI 界面，以美观的蓝色风格实测通过。 一、 Swagger 简介 Swagger 是一个基于 OpenAPI 规范的 API 文档生成工具，能够自动生成 RESTful ...
swagger2postman:从swagger json更新邮递员集合，以避免每次创建
05-06
更新SWAGGER的邮递员收藏 该工具可以从swagger json更新邮递员收藏，从而避免每次创建。 注意：这些工具将旧配置与新配置合并，但对于请求正文，它将保留现有配置，而不是合并。 用 克隆此存储库 安装套件 确保您已...
postman如何导入API.json文件
陌上人如玉，公子世无双
06-11 1万+
postman如何导入API.json文件
postman如何导入API.json文件 - 图文教程
草巾冒小子的博客
09-27 1万+
图文教程 · 示下： 以上就是关于“ postman如何导入API.json文件 - 图文教程 ”的全部内容。
postman导入json格式的接口文档
最新发布
zengliguang的专栏
06-21 1万+
点击下载，等待下载完成即可。
swagger页面不显示_Swagger UI在index.html页面上不显示任何内容
weixin_28992423的博客
01-30 3813
UPDATED with SOLUTION below!!!////////////////////////////////////////////////// ////////////感谢Ron的建议，我略微修改了我的设置，使用BeanConfig而不是SwaggerConfig，并使其正常工作 . 为了做到这一点，我不得不修改servlet，并且(这是我认为缺少的部分)将BeanConfig条...
postman导入json文件（包含签名）
minihuabei的博客
08-18 1万+
{ "info": { "_postman_id": "e2242e4c-69ba-4ce9-ad18-b052c1c24454", "name": "诺云放开接口", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "/Third/Tools/checkSign", "event": [ { ".
Postman循环调用接口 以及 导入导出json文件
热门推荐
weixin_44601709的博客
01-22 1万+
Postman循环调用接口 以及 导入导出json文件 当需要批量调用或测试https/http请求。可以考虑使用Postman来进行操作实现。 团队之间接口交流通过PostMan打包导入。 具体操作如下:      新建collection，创建请求，调用一次。确认请求成功。也可以先创建了请求之后创建collection，把请求保存进collection。     进入collectio...
使用Postman传递JSON格式数据到后台并用@RequestBody注解接收
weixin_45058795的博客
11-30 2184
简单的写一个登陆案例,简单明了.可以更快速的学习! 一: 后端代码的书写: 请求路径 2)请求方法 3)参数 其中admin对象是你的pojo类,用户名和密码一定要一一对应,我的有波浪线是因为阿里巴巴规范,注释不能写在属性后面. 二:postman的书写: (1) 提交方式 post (2)请求路径 (3)json格式 三:总结 在传递json字符串的时候,一定要记得和你的pojo类中的属性名一一对应,要不然后端没办法接受哦! ...
导入从postman导出的json接口文件，并设置全局变量
qq_39820568的博客
03-09 2975
前置条件： 1、安装好的postman 2、json接口文件里有登陆接口（获取token用） 分为以下步骤： 第一步（导入json接口文件）： 第二步（设置全局请求地址）： 到这里就设置好请求地址的全局变量了，接着可以开始使用了，例： 第三步（如果登录接口没有验证码的可以忽略）： ...
swagger(三)：统一返回结果不显示字段说明
风之子
01-29 1万+
1. 正常显示情况 正常情况下,不管是调试还是文档说明都会显示以上字段说明。 2. 非正常情况 2.1 返回Object 不显示 响应参数不显示字段属性： 2.2 返回Map不显示 为何返回Map不显示,大家都知道Map是Java里面的集合接口,不管是Map本身还是诸如HashMap等子实现,这类数据对于Swagger来说都是未定义结构的数据 Swagger只认识定义好的类-属性，所以接口返回Map,对于Swagger来说是没有字段展示的,这种情况同样适用与返回Object这...
在Web API项目中，用Swagger描述API接口的例子？
05-16
以下是一个使用Swagger描述API接口的Web API项目的示例： ```csharp using System.Collections.Generic; using Microsoft.AspNetCore.Mvc; namespace MyWebApi.Controllers { [ApiController] [Route("[controller]")] public class UsersController : ControllerBase { /// <summary> /// 获取所有用户 /// </summary> /// <returns>用户列表</returns> [HttpGet] [ProducesResponseType(typeof(IEnumerable<User>), 200)] public IActionResult GetAllUsers() { return Ok(new List<User> { new User { Id = 1, Name = "Alice" }, new User { Id = 2, Name = "Bob" } }); } /// <summary> /// 获取指定用户 /// </summary> /// <param name="id">用户ID</param> /// <returns>用户信息</returns> [HttpGet("{id}")] [ProducesResponseType(typeof(User), 200)] [ProducesResponseType(404)] public IActionResult GetUser(int id) { var user = new User { Id = id, Name = "Alice" }; if (user == null) { return NotFound(); } return Ok(user); } /// <summary> /// 添加用户 /// </summary> /// <param name="user">用户信息</param> /// <returns>添加结果</returns> [HttpPost] [ProducesResponseType(typeof(User), 201)] [ProducesResponseType(400)] public IActionResult AddUser(User user) { if (user == null) { return BadRequest(); } user.Id = 3; // 模拟分配ID return CreatedAtAction(nameof(GetUser), new { id = user.Id }, user); } /// <summary> /// 更新用户 /// </summary> /// <param name="id">用户ID</param> /// <param name="user">用户信息</param> /// <returns>更新结果</returns> [HttpPut("{id}")] [ProducesResponseType(204)] [ProducesResponseType(400)] [ProducesResponseType(404)] public IActionResult UpdateUser(int id, User user) { if (user == null || user.Id != id) { return BadRequest(); } // 更新用户信息 return NoContent(); } /// <summary> /// 删除用户 /// </summary> /// <param name="id">用户ID</param> /// <returns>删除结果</returns> [HttpDelete("{id}")] [ProducesResponseType(204)] [ProducesResponseType(404)] public IActionResult DeleteUser(int id) { // 删除用户信息 return NoContent(); } } public class User { public int Id { get; set; } public string Name { get; set; } } } ``` 在上面的示例中，我们使用了 `[ApiController]` 和 `[Route]` 特性来定义控制器和路由。其中，`[ApiController]` 告诉 ASP.NET Core 这是一个 Web API 控制器，并使用默认的行为，例如自动模型绑定和验证。`[Route]` 特性指定了控制器的路由前缀。 每个操作方法都有一个 HTTP 动词特性，例如 `[HttpGet]`，指定了该方法对应的 HTTP GET 请求。我们还使用了`[ProducesResponseType]` 特性，用于指定操作方法的返回类型及其 HTTP 状态码。这些信息可以帮助 Swagger 自动生成 API 文档。 在上面的示例中，我们使用了标准的 HTTP 状态码和响应模型。但是，你也可以使用自定义的状态码和响应模型，只需在`[ProducesResponseType]` 特性中指定即可。 当你启用 Swagger 后，你可以在浏览器中访问 `http://localhost:<port>/swagger` 查看自动生成的 API 文档。
评论 11
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值