Springboot3 集成knife4j(swagger)

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

官网地址:

Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j

本文以Springboot3+版本集成knife4j叙述(请注意版本差别,不同版本写法不同)

第一步:创建Spring Boot项目并且在pom.xml中引入Knife4j的依赖包,代码如下:

XML 复制代码
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
	<version>4.4.0</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-spring-web</artifactId>
	<version>3.0.0</version>
</dependency>

第二步:创建Swagger配置依赖,代码如下:

java 复制代码
package blog.web.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Knife4jConfiguration {

    @Bean
    public Docket docketAdmin() {
        System.out.println("swagger 准备生成接口文档...");
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("清山博客文档")
                .version("2.0")
                .description("清山博客项目接口文档")
                .build();

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("管理端接口")
                .apiInfo(apiInfo)
                .select()
                //  指定swagger需要扫描的包
                .apis(RequestHandlerSelectors.basePackage("blog.web"))
                .paths(PathSelectors.any())
                .build();
    }
}

第三步:新建一个接口Controller类,如下:

java 复制代码
@RestController
@RequestMapping("body")
@Tag(name = "body参数")
public class BodyController {

   @Operation(summary = "普通body请求")
   @PostMapping("/body")
   public ResponseEntity<FileResp> body(@RequestBody FileResp fileResp){
       return ResponseEntity.ok(fileResp);
   }

   @Operation(summary = "普通body请求+Param+Header+Path")
   @Parameters({
           @Parameter(name = "id",description = "文件id",in = ParameterIn.PATH),
           @Parameter(name = "token",description = "请求token",required = true,in = ParameterIn.HEADER),
           @Parameter(name = "name",description = "文件名称",required = true,in=ParameterIn.QUERY)
   })
   @PostMapping("/bodyParamHeaderPath/{id}")
   public ResponseEntity<FileResp> bodyParamHeaderPath(@PathVariable("id") String id,@RequestHeader("token") String token, @RequestParam("name")String name,@RequestBody FileResp fileResp){
       fileResp.setName(fileResp.getName()+",receiveName:"+name+",token:"+token+",pathID:"+id);
       return ResponseEntity.ok(fileResp);
   }
}

注意事项:

1.Spring Boot 3 只支持OpenAPI3规范

2.Knife4j提供的starter已经引用springdoc-openapi的jar,开发者需注意避免jar包冲突

3.JDK版本必须 >= 17

参考:

快速开始 | Knife4j

相关推荐
码银38 分钟前
Java 集合:泛型、Set 集合及其实现类详解
java·开发语言
大G哥40 分钟前
PHP标签+注释+html混写+变量
android·开发语言·前端·html·php
东阳马生架构40 分钟前
Nacos简介—4.Nacos架构和原理
java
傻啦嘿哟1 小时前
HTTP代理基础:网络新手的入门指南
开发语言·php
fish_study_csdn1 小时前
pytest 技术总结
开发语言·python·pytest
一只叫煤球的猫1 小时前
你真的会用 return 吗?—— 11个值得借鉴的 return 写法
java·后端·代码规范
颇有几分姿色2 小时前
Spring Boot 读取配置文件的几种方式
java·spring boot·后端
爱编程的鱼2 小时前
C# 枚举(Enum)声明与使用详解
java·windows·c#
人生导师yxc2 小时前
Spring MVC
java·spring·mvc
曹牧2 小时前
Java 调用webservice接口输出xml自动转义
java·开发语言·javascript