SpringBoot集成Swagger+Knife4j

详细教程链接：https://blog.csdn.net/xhmico/article/details/131701790

 

在pom.xml中引入依赖

        <!-- knife4j 接口文档 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
            <version>4.4.0</version>
        </dependency>

在application.yml中修改增强配置

knife4j:
  # 开启增强配置
  enable: true
  # 开启Swagger的Basic认证功能,默认是false
  basic:
    enable: true
    # Basic认证用户名
    username: root
    # Basic认证密码
    password: root

常用注解：

Swagger3	注解说明
@Tag(name = “接口类描述”)	Controller 类
@Operation(summary =“接口方法描述”)	Controller 方法
@Parameters	Controller 方法
@Parameter(description=“参数描述”)	Controller 方法上 @Parameters 里Controller 方法的参数
@Parameter(hidden = true) 、@Operation(hidden = true)@Hidden	排除或隐藏api
@Schema	DTO实体DTO实体属性