Spring Boot入门(17)：使用Knife4j让你的Spring Boot API文档更具可读性和可视化效果

已于 2023-10-08 11:25:08 修改
阅读量1k 收藏 3
点赞数 2
分类专栏： 《滚雪球学Spring Boot》 《Spring Boot30天速成》 文章标签： SpringBoot零基础入门 Spring Boot Knife4j 美化强化丑陋的Swagger
于 2023-05-09 10:29:39 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43970743/article/details/130561847
版权

1. 前言🔥

        在上一期我们重点学习了《Spring Boot 整合 Swagger-UI 实现在线API接口文档》，虽然在使用 Spring Boot 开发前后端分离项目的时候，都会用到它(Swagger)

        但随着系统功能的不断增加，接口数量的爆炸式增长，Swagger 的使用体验也就会变得越来越差，比如请求参数为 JSON 的时候没办法格式化，返回结果没办法折叠，还有就是没有提供搜索功能。

        今天我们介绍的主角 Knife4j 就弥补了这些不足，赋予了 Swagger 更强的生命力和表现力。

        接下来我会重点给大家介绍MP如何自定义sql，这将又会是干货满满的一期，全程无尿点不废话只抓重点教，具有非常好的学习效果，拿好小板凳准备就坐！希望学习的过程中大家认真听好好学，学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信，bug菌将第一时间给予解惑，那么废话不多说，直接开整！Fighting！！

2. 环境说明🔥</

了解本专栏 订阅专栏 解锁全文 超级会员免费看
bug菌¹
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
订阅专栏
spring boot 集成swagger+knife4j，集成mybatis-plus和代码生成器
10-28
spring boot快速上手示例，集成了swagger+knife4j接口文档，集成mybatis-plus持久化，统一的数据返回封装，集成mybatis-plus-generator代码生成器，加入了lombok框架，一个完成的sping boot 示例项目，简单易上手
项目接口文档管理之swagger-ui+ knife4j
IT界的一只菜鸟
12-16 445
项目接口文档管理之swagger-ui+ knife4j
Swagger的界面太丑，试试knife4j的接口文档吧
笑小枫
07-04 839
SpringBoot项目如果前后端分离，怎么把写好了的接口返回给前端的小伙伴呢，试试这款基于Swagger2的knife4j吧，简直好用到爆！
SpringBoot整合Knife4j，美化API接口文档界面
c1441173216的博客
10-26 380
Spring Boot整合Knife4j操作非常简单就常规的三步骤：引依赖、写配置类、改yml。以及常用注解说明。
再见丑陋的 SwaggerUI，这款API文档生成神器界面更炫酷，逼格更高！
方志朋的博客
03-01 217
欢迎关注方志朋的博客，回复”666“获面试宝典一般在使用 Spring Boot 开发前后端分离项目的时候，都会用到 Swagger。Swagger 是一个规范和完整的框架，用于生成、描述...
Swagger配置 配置knife4j 好看的ui界面
qq_46126559的博客
06-28 2677
Swagger 官方文档 使用 很好看的ui界面 推荐使用 两个都可以用 看个人爱好 doc: http://localhost:8088/doc.html Swagger: http://localhost:8088/swagger-ui.html 导入依赖 <!-- 生成api文档--> <dependency> <groupId>io.springfox</groupId>
swagger2搭配knife4j 隐藏实体类的属性/字段
qq_45900875的博客
07-04 1707
swagger2搭配knife4j 隐藏实体类的属性/字段
Knife4j/Swagger2 忽略实体类或 List 属性，含接收 MyBatis Plus 分页 Page 参数、返回 Page 对象写法
欲穷三千界
05-12 3031
分页接口使用继承了 Page 的对象接收参数； 只需要 Swagger 页面显示 **current**、**size**，但是页面上却展示了一堆入参，hidden 无效； 返回对象中含 Page 对象时； Swagger 版本 2.10.5。
knife4j（swagger的升级版）使用
辉之素狂
03-24 2995
目前很多的后台都开始使用swagger来写文档接口了，但是swagger有很多限制： 1、swagger不支持头部自定义加入参数，如果是头部有token等之类参数要放入时swagger就无法调试接口了，只有看的份了。 2、swagger对application/json请求的类型的确实很友好，但是对于表单类型的application/x-www-form-urlencoded就很不友好了，你使...
JAVA中让Swagger产出更加符合我们诉求的描述文档，按需决定显示或者隐藏指定内容
是Vzn呀
09-08 1217
swagger作为一个被广泛使用的在线接口文档辅助工具，上手会用很容易，但想用好却还是需要一定功夫的。所以呢，本篇文档就和大家一起来聊一聊如何用好swagger，让其真正的成为项目中的神兵利器。
Knife4j使用教程（三） -- 实体类的配置注解（@ApiModel与@ApiModelProperty 的 认识与使用）
最新发布
PUYALEI的博客
10-27 1204
Knife4j使用教程（三） -- 实体类的配置注解（@ApiModel与@ApiModelProperty 的 认识与使用）
Springboot使用Knife4j
03-16
Springboot使用Knife4j
Knife4j各版本集成SpringBoot 2.x 3.x版本demo示例
04-23
Knife4j各版本集成SpringBoot 2.x 3.x版本demo示例，亲测可用 ，仅供学习使用。
swagger文档以及knife4j文档
04-02
通过SpringBoot集成Api文档（Swagger文档）和（knife4j文档）。启动项目后 Swaggger文档访问地址：localhost:8888/swagger-ui.html knife4j文档访问地址:localhost:8888/doc.html
knife4j-aggregation-spring-boot-starter-2.0.8.jar
02-21
Knife4j是为Java MVC框架集成化Swagger形成Api文本文档的增强解决方法，原名swagger-bootstrap-ui，取名字kni4j是期待她能像一把短刀一样精巧、轻巧、而且作用强大！【软件详细介绍】Knife4j的原名是swagger-...
【Swagger介绍】【knife4j介绍】
m0_62220641的博客
05-06 739
7.4.2 Swagger介绍 (1)简介 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务(API Documentation & Design Tools for Teams | Swagger)。 它的主要作用是： 使得前后端分离开发更加方便，有利于团队协作 接口的文档在线自动生成，降低后端开发人员编写接口文档的负担 功能测试 Spring已经将Swagger纳入自身的标准，建立了Spring-swa.
Knife4j 的基本使用说明
Melody_1943的博客
06-10 1655
Knife4j是一款可以提供在线API文档的框架，是基于Swagger框架实现的。在Spring Boot项目中，使用Knife4j需要添加依赖： ​ 然后，需要添加配置，则在项目的包下创建类：​ 完成后启动项目，从浏览器进入localhost：8080.doc.html#/home即可进入 ​ 注意：必须修改以上配置中的包名，保证是当前项目中控制器类所在的包！其它各项均可不修改，以上配置代码可以从Knife4j的官网找到！最后，还需要在配置文件中开启Knife4j的增强模式： 完成后，启动项目，在浏览
knif4j返回的vo中含有List，却不能展示List元素的说明
weixin_39357332的博客
08-05 488
knif4j使用
knife4j中部分接口的请求参数中的字段无法显示
qq_42449963的博客
11-11 2837
比如A接口中参数的AClass类可以正常显示，但是B接口中的BClass类不能正常显示，那就把AClass类中内容全部复制到BClass类中，然后改下名称为BClass，之后把对应属性也换一下，以及注解中的内容也换一下。找到能正常显示的接口参数类，然后复制一下类并改下名称，之后把对应属性复制过去即可。
spring boot 使用knife4j2.9,接口文档地址加入访问前缀
03-29
在Spring Boot中使用Knife4j 2.9生成接口文档时，可以通过配置文件添加访问前缀。具体操作如下： 1. 在pom.xml文件中添加Knife4j的依赖： ``` <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.9.0</version> </dependency> ``` 2. 在application.yml或application.properties文件中添加如下配置： ``` # 设置接口文档的访问前缀 springfox.documentation.swagger-ui.path=/api-docs ``` 其中，`/api-docs`为你要设置的访问前缀。 3. 启动Spring Boot应用后，访问接口文档的地址为： ``` http://localhost:8080/api-docs/index.html ``` 其中，`/api-docs`为你在配置文件中设置的访问前缀。如果你设置的访问前缀为其他值，也要相应地修改访问地址。 注意：如果使用的是Knife4j 2.0以下的版本，访问地址为： ``` http://localhost:8080/doc.html ``` 希望以上内容能够帮助你解决问题。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

bug菌¹

你的鼓励将是我创作的最大动力。

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值