SpringBoot3整合Knife4j之保姆级教程

整合

Knife4j

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

整合参考：

https://doc.xiaominfo.com/docs/quick-start

1. 新建：创建一个名为web的SpringBoot3项目
2. 依赖：web模块引入knife4j依赖

<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-openapi3-jakarta-spring-boot-starter --><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId></dependency>

1. 配置：在web模块resources目录 application-config.yml文件中添加

# springdoc-openapi项目访问访问地址: http://127.0.0.1:8080/doc.htmlspringdoc:swagger-ui:path: /swagger-ui.html
    # path: 配置swagger-ui.html/UI界面的访问路径,默认为/swagger-ui.htmltags-sorter: alpha
    # tags-sorter: 接口文档中的tags排序规则,默认为alpha,可选值为alpha(按字母顺序排序)或as-is(按照在代码中定义的顺序排序)operations-sorter: alpha

  api-docs:path: /v3/api-docs
    # path: 配置api-docs的访问路径,默认为/v3/api-docsgroup-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#/homeknife4j:enable:true# 设置为true以启用Knife4j增强功能,这将再应用程序中启用Knife4j UIsetting:# language: 设置Knife4j UI的语言,默认为zh_cn,可选值为zh_cn或enlanguage: zh_cn
  #开启生产环境屏蔽production:false#是否启用登录认证basic:enable:trueusername:# 自己设置一个password:# 自己设置一个

1. 测试：web模块web包下TestController包下新建 Knife4jTestRestController类

注：

test

目录下新建的非测试类在生成

target

时会被删掉

4. 设置首页：web模块web包下cofig包下新建 Knife4jConfig类
参考文章：https://blog.csdn.net/2301_78646673/article/details/134791387packagecn.bytewisehub.pai.web.config;importio.swagger.v3.oas.models.ExternalDocumentation;importio.swagger.v3.oas.models.OpenAPI;importio.swagger.v3.oas.models.info.Contact;importio.swagger.v3.oas.models.info.Info;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;@ConfigurationpublicclassKnife4jConfig{@BeanpublicOpenAPIspringShopOpenAPI(){returnnewOpenAPI()// 接口文档标题.info(newInfo().title("API接口文档")// 接口文档简介.description("pai api doc")// 接口文档版本.version("0.0.1-SNAPSHOT")// 开发者联系方式.contact(newContact().name("CSDN柳衣白卿").email("[email protected]"))).externalDocs(newExternalDocumentation().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

packagecn.bytewisehub.pai.web.config;importio.swagger.v3.oas.models.ExternalDocumentation;importio.swagger.v3.oas.models.OpenAPI;importio.swagger.v3.oas.models.info.Contact;importio.swagger.v3.oas.models.info.Info;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;@ConfigurationpublicclassKnife4jConfig{@BeanpublicOpenAPIspringShopOpenAPI(){returnnewOpenAPI()// 接口文档标题.info(newInfo().title("API接口文档")// 接口文档简介.description("pai api doc")// 接口文档版本.version("0.0.1-SNAPSHOT")// 开发者联系方式.contact(newContact().name("CSDN柳衣白卿").email("[email protected]"))).externalDocs(newExternalDocumentation().description("paicoding api doc").url("http://127.0.0.1:8888"));}}