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

相关内容

热门资讯

2分钟科普!多乐跑得快,Wep... 2分钟科普!多乐跑得快,WepokE真是有挂,切实教程(有挂工具)1、操作简单,无需注册,只需要使用...
四分钟辅助!同城比鸡取胜,We... 四分钟辅助!同城比鸡取胜,WePoKer一直真的有挂,AI教程(有挂透明)1、同城比鸡取胜ai辅助优...
6分钟了解!拱趴十三水调胜率软... 6分钟了解!拱趴十三水调胜率软件,wepoke果然存在有挂,揭秘教程(有挂技巧);1、下载好拱趴十三...
5分钟科普!欢乐麻将手机麻将辅... 5分钟科普!欢乐麻将手机麻将辅牌器,aAPOKER原来真的有挂,普及教程(有挂辅助挂);1、下载好欢...
4分钟了解!多多来了有挂吗,W... 4分钟了解!多多来了有挂吗,Wpk好像有挂,新2025版(有挂揭秘)多多来了有挂吗是一种具有地方特色...
八分钟辅助挂!开心联盟牛牛外 ... 八分钟辅助挂!开心联盟牛牛外 挂多少钱,手机德州其实真的有挂,微扑克教程(有挂详情);该软件可以轻松...
三分钟攻略!白金岛放炮罚辅助器... 三分钟攻略!白金岛放炮罚辅助器,来玩app德州真是存在有挂,教你攻略(有挂软件)1、全新机制【白金岛...
8分钟攻略!哥哥跑得快有挂吗,... 8分钟攻略!哥哥跑得快有挂吗,咪咪扑克果然有挂,必赢方法(有挂教学)哥哥跑得快有挂吗辅助器中分为三种...
9分钟辅助挂!衡阳丫丫字牌有没... 9分钟辅助挂!衡阳丫丫字牌有没有外挂,wEPOKE真是是真的有挂,攻略教程(有挂解说)衡阳丫丫字牌有...
一分钟实锤!七彩全民雀神辅助,... 一分钟实锤!七彩全民雀神辅助,WepOke原来存在有挂,专业教程(有挂技巧);七彩全民雀神辅助辅助器...