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

整合Knife4j

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

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

  1. 新建:创建一个名为web的SpringBoot3项目

  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"));     } } 

相关内容

热门资讯

一分钟了解辅助!新518互游辅... 一分钟了解辅助!新518互游辅助多功能AI软件,新518互游真是真的是有辅助软件1、新518互游辅助...
终于清楚开挂!卡米大厅开挂多功... 终于清楚开挂!卡米大厅开挂多功能AI方法,卡米大厅其实存在有开挂方法1、下载好卡米大厅正确养号方法之...
六分钟了解作弊器!玄灵大厅作弊... 六分钟了解作弊器!玄灵大厅作弊器多功能AI软件,玄灵大厅真是有作弊器软件1、很好的工具软件,可以解锁...
一起来讨论外挂!椰子大厅外挂多... 一起来讨论外挂!椰子大厅外挂多功能AI攻略,椰子大厅原来是真的有外挂攻略1、椰子大厅辅助软件下载优化...
玩家必看教程辅助!鲨鱼众娱辅助... 玩家必看教程辅助!鲨鱼众娱辅助多功能AI攻略,鲨鱼众娱一直真的是有辅助攻略1、许多玩家不知道鲨鱼众娱...
盘点一款开挂!皇豪大厅开挂多功... 盘点一款开挂!皇豪大厅开挂多功能AI攻略,皇豪大厅确实是真的有开挂攻略1、进入到皇豪大厅是否有挂之后...
教学盘点辅助器!老夫子大厅辅助... 教学盘点辅助器!老夫子大厅辅助器多功能AI攻略,老夫子大厅竟然真的是有辅助器攻略1、该软件可以轻松地...
热点推荐透视挂!嗨玩娱乐麻将透... 热点推荐透视挂!嗨玩娱乐麻将透视挂多功能AI软件,嗨玩娱乐麻将本来真的是有透视挂软件1、下载好嗨玩娱...
一分钟揭秘作弊器!黑莓大厅作弊... 一分钟揭秘作弊器!黑莓大厅作弊器多功能AI教程,黑莓大厅本来是真的有作弊器教程1、首先打开黑莓大厅辅...
玩家必看科普开挂!七天娱乐开挂... 玩家必看科普开挂!七天娱乐开挂多功能AIapp,七天娱乐竟然存在有开挂app1、七天娱乐公共底牌简单...