SpringBoot3整合Knife4j之保姆级教程
创始人
2025-01-10 17:06:34
0

整合Knife4j

  1. 介绍:Spring MVC框架集成Swagger2生成Api文档的增强解决方案

整合参考: https://doc.xiaominfo.com/docs/quick-start

  1. 新建:创建一个名为webSpringBoot3项目

  2. 依赖:web模块引入knife4j依赖

      com.github.xiaoymin     knife4j-openapi3-jakarta-spring-boot-starter  
  1. 配置:在web模块resources目录 application-config.yml文件中添加
# springdoc-openapi项目访问访问地址: http://127.0.0.1:8080/doc.html springdoc:   swagger-ui:     path: /swagger-ui.html     # path: 配置swagger-ui.html/UI界面的访问路径,默认为/swagger-ui.html     tags-sorter: alpha     # tags-sorter: 接口文档中的tags排序规则,默认为alpha,可选值为alpha(按字母顺序排序)或as-is(按照在代码中定义的顺序排序)     operations-sorter: alpha    api-docs:     path: /v3/api-docs     # path: 配置api-docs的访问路径,默认为/v3/api-docs    group-configs:     # group-configs: 配置分组信息     - group: 'default'       # group: 分组名称       paths-to-match: '/**'       # paths-to-match: 配置要匹配的路径,默认为/**       packages-to-scan: cn.bytewisehub.pai.web       # packages-to-scan: 配置要扫描的包的路径,直接配置为Controller类所在的包名即可  # knife4j项目访问访问地址:http://127.0.0.1:8080/doc.html#/home knife4j:   enable: true   # 设置为true以启用Knife4j增强功能,这将再应用程序中启用Knife4j UI   setting:     # language: 设置Knife4j UI的语言,默认为zh_cn,可选值为zh_cn或en     language: zh_cn   #开启生产环境屏蔽   production: false   #是否启用登录认证   basic:     enable: true     username: # 自己设置一个     password: # 自己设置一个 
  1. 测试:web模块web包下TestController包下新建 Knife4jTestRestController

注:test目录下新建的非测试类在生成target时会被删掉

4. 设置首页:web模块web包下cofig包下新建 Knife4jConfig类 参考文章:https://blog.csdn.net/2301_78646673/article/details/134791387 package cn.bytewisehub.pai.web.config;  import io.swagger.v3.oas.models.ExternalDocumentation; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Contact; import io.swagger.v3.oas.models.info.Info; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration;  @Configuration public class Knife4jConfig {      @Bean     public OpenAPI springShopOpenAPI() {         return new OpenAPI()         // 接口文档标题         .info(new Info().title("API接口文档")               // 接口文档简介               .description("pai api doc")               // 接口文档版本               .version("0.0.1-SNAPSHOT")               // 开发者联系方式               .contact(new Contact().name("CSDN柳衣白卿")                        .email("506567828@qq.com")))         .externalDocs(new ExternalDocumentation()                       .description("paicoding api doc")                       .url("http://127.0.0.1:8888"));     } } 
  1. 设置首页:web模块web包下cofig包下新建 Knife4jConfig

参考文章:https://blog.csdn.net/2301_78646673/article/details/134791387

package cn.bytewisehub.pai.web.config;  import io.swagger.v3.oas.models.ExternalDocumentation; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Contact; import io.swagger.v3.oas.models.info.Info; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration;  @Configuration public class Knife4jConfig {      @Bean     public OpenAPI springShopOpenAPI() {         return new OpenAPI()         // 接口文档标题         .info(new Info().title("API接口文档")               // 接口文档简介               .description("pai api doc")               // 接口文档版本               .version("0.0.1-SNAPSHOT")               // 开发者联系方式               .contact(new Contact().name("CSDN柳衣白卿")                        .email("506567828@qq.com")))         .externalDocs(new ExternalDocumentation()                       .description("paicoding api doc")                       .url("http://127.0.0.1:8888"));     } } 

相关内容

热门资讯

一分钟内幕!科乐吉林麻将系统发... 一分钟内幕!科乐吉林麻将系统发牌规律,福建大玩家确实真的是有挂,技巧教程(有挂ai代打);所有人都在...
一分钟揭秘!微扑克辅助软件(透... 一分钟揭秘!微扑克辅助软件(透视辅助)确实是有挂(2024已更新)(哔哩哔哩);1、用户打开应用后不...
五分钟发现!广东雀神麻雀怎么赢... 五分钟发现!广东雀神麻雀怎么赢,朋朋棋牌都是是真的有挂,高科技教程(有挂方法)1、广东雀神麻雀怎么赢...
每日必看!人皇大厅吗(透明挂)... 每日必看!人皇大厅吗(透明挂)好像存在有挂(2026已更新)(哔哩哔哩);人皇大厅吗辅助器中分为三种...
重大科普!新华棋牌有挂吗(透视... 重大科普!新华棋牌有挂吗(透视)一直是有挂(2021已更新)(哔哩哔哩)1、完成新华棋牌有挂吗的残局...
二分钟内幕!微信小程序途游辅助... 二分钟内幕!微信小程序途游辅助器,掌中乐游戏中心其实存在有挂,微扑克教程(有挂规律)二分钟内幕!微信...
科技揭秘!jj斗地主系统控牌吗... 科技揭秘!jj斗地主系统控牌吗(透视)本来真的是有挂(2025已更新)(哔哩哔哩)1、科技揭秘!jj...
1分钟普及!哈灵麻将攻略小,微... 1分钟普及!哈灵麻将攻略小,微信小程序十三张好像存在有挂,规律教程(有挂技巧)哈灵麻将攻略小是一种具...
9分钟教程!科乐麻将有挂吗,传... 9分钟教程!科乐麻将有挂吗,传送屋高防版辅助(总是存在有挂)1、完成传送屋高防版辅助透视辅助安装,帮...
每日必看教程!兴动游戏辅助器下... 每日必看教程!兴动游戏辅助器下载(辅助)真是真的有挂(2025已更新)(哔哩哔哩)1、打开软件启动之...