将swagger-ui中的接口导入postman

1.简介

swagger是一款深受广大后端开发人员喜爱的工具,它能够帮助使用者减少文档的编写,且能够以可视化界面的形式呈现接口,方便测试。使用swagger唯一的缺陷在于需要用注解对每个接口进行解释说明,无形中也增加一些代码量。本文将详细介绍将swagger声明的接口快速导入postMan,快速进行测试。
2.swagger配置篇
(1)导入依赖jar包
首先在所要使用swagger的工程中导入相关依赖,主要的依赖有:

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>

(2)编写配置类
在这里插入图片描述
(3)启动类上添加配置类扫描路径和@EnableSwagger2注解,同时注意还需要添加controller类所在的扫描路径,否则可能出现无法找到注解接口的情况。
3.controller类和其对应的方法进行注解
具体注解可查看swagger的相关文档。
在这里插入图片描述
在这里插入图片描述
4.访问swagger的可视化页面
访问路径在配置类中已经配置过:http://localhost:15031/swagger-ui.html#/
在这里插入图片描述
5.将接口导入到postMan
(1)找到上述文档路径,也就是上图中的:http://localhost:15031/v2/api-docs,将其导入postMan。注意,导入时项目要处于运行状态,否则导入不成功。
在这里插入图片描述
(2)导入成功后,根据需要配置具体测试环境和生产环境地址,方便测试不同环境的接口。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
(3)测试具体接口
在这里插入图片描述

  • 0
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger-UI在线接口文档的优点包括以下几个方面: 1. 支持接口文档导出:Swagger-UI可以将接口文档以PDF、Word和Markdown等格式导出,方便开发者进行离线查阅和分享。[2] 2. 多种方式使用:Swagger-UI可以与其他工具同时使用,比如springfox-swagger-ui,可以根据项目需求选择最适合的方式。[2] 3. 友好的界面:相比于springfox-swagger-uiSwagger-UI的界面更加友好,排版结构更加清晰,使得接口文档更易于理解和使用。[2] 4. 搜索功能:Swagger-UI支持接口内容的搜索,可以快速定位到需要查找的接口,提高了开发效率。[2] 5. 接口版本管理:Swagger-UI可以对接口进行版本管理,方便开发者对接口进行更新和维护。[2] 6. 国际化支持:Swagger-UI支持多语言界面,可以根据用户的语言偏好进行界面显示。[2] 7. 自定义文档:Swagger-UI支持开发者对接口文档进行自定义,可以根据项目需求添加额外的信息和说明。[2] 8. 生产环境屏蔽:Swagger-UI支持在生产环境屏蔽Swagger的所有资源接口,保护接口文档的安全性。[2] 9. 接口权限控制:Swagger-UI可以设置在线接口文档的权限控制,限制不同用户对接口文档的访问权限。[2] 综上所述,Swagger-UI在线接口文档具有导出、多种使用方式、友好界面、搜索功能、版本管理、国际化支持、自定义文档、生产环境屏蔽和权限控制等优点。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值