Swagger增强神器:Knife4j!用它轻松实现接口搜索、Word下载、接口过滤...(1)

简介: Swagger增强神器:Knife4j!用它轻松实现接口搜索、Word下载、接口过滤...(1)

image.png



Swagger 是开发中最常用的框架之一了,但 Swagger 本身又有很多不完善的地方,比如,在众多的接口中查询某一个接口,又或者是把所有的接口导出成 Word 格式等,都无法在 Swagger 中实现。


有人可能会问:为什么要把接口导成 Word 格式?这种场景还挺常见的,比如需要将接口对外部公司开放时,又或者是开发环境的网络不能对外部开放(如专线,很多医院都拉的是专线),而生产环境的 Swagger 又是关闭状态的时候,这时候只能依赖离线文档来实现接口的调用了,而离线文档最常用的格式便是 Word 了。


那么为了解决 Swagger 的这些问题,我们需要使用一个 Swagger 的增强工具来实现,而这个扩展工具就是我们今天要重点介绍的 Knife4j,那 Knife4j 长得是什么样呢?我们一起来看,如下图所示:


微信图片_20220120165142.jpg


从这个主页可以看出,Knife4j 会将 Swagger 中设置的摘要信息(Docket)显示在欢迎页,Docket 的设置可以看我之前的文章,并且 Knife4j 还很贴心的提供了一个统计所有接口的功能,在欢迎页的最下方我们可以很清楚的看到当前 POST 接口的数量,以及 GET 的接口的数量。


PS:Knife4j 支持中文和英文两种语言展示,对于国内的小伙伴来说,可读性非常的高(因为都是中文的嘛)。


Knife4j 功能介绍


1.搜索功能


我觉得 Knife4j 最实用的一个功能就是“接口搜索”了,通过这个功能我们可以非常方便的找到我们需要的接口,如下图所示:


微信图片_20220120165205.jpg



相关文章
|
4月前
|
API
支付系统38-----支付宝支付---统一收单线下交易查询 第一步下单------》发起支付请求,登录,确认支付,查单接口开发,swagger接口全部呈现,
支付系统38-----支付宝支付---统一收单线下交易查询 第一步下单------》发起支付请求,登录,确认支付,查单接口开发,swagger接口全部呈现,
|
6月前
|
Java Spring
Spring Boot3整合knife4j(swagger3)
Spring Boot3整合knife4j(swagger3)
1317 1
|
1月前
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
103 1
|
1月前
|
安全 Java API
SpringSecurity结合knife4j实现swagger文档
通过将Spring Security与Knife4j相结合,我们不仅能够为RESTful API提供强大的安全防护,还能保证API文档的易用性和可访问性,这对于API的设计、开发和维护来说至关重要。这种集成方式不仅提升了开发效率,也优化了API使用者的体验,是现代API驱动开发中不可或缺的一环。
77 0
|
4月前
|
JSON 数据格式
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
|
6月前
Swagger基本使用与RestTemplate发送http接口测试
Swagger基本使用与RestTemplate发送http接口测试
80 1
|
6月前
|
开发框架 JSON .NET
初学者不会写接口怎么办?微软Visual Studio 2022无脑式API接口创建——Swagger一键导入APIKit快速测试
初学者不会写接口怎么办?微软Visual Studio 2022无脑式API接口创建——Swagger一键导入APIKit快速测试
362 0
|
6月前
|
Java Maven
(knife4j)Swagger-JAVAapi文档生成器
(knife4j)Swagger-JAVAapi文档生成器
52 1
|
6月前
|
前端开发 搜索推荐 Java
springboot集成swagger knife4j 最详细的步骤 手把手教你继承swagger
springboot集成swagger knife4j 最详细的步骤 手把手教你继承swagger
613 0
springboot集成swagger knife4j 最详细的步骤 手把手教你继承swagger
|
6月前
|
前端开发 应用服务中间件 nginx
使用swagger和knife4j生成的接口文档在浏览器中输入地址后报404错误
使用swagger和knife4j生成的接口文档在浏览器中输入地址后报404错误
517 0
下一篇
无影云桌面