后端Spring Boot 集成Knife4j

环境准备

适用于spring boot > 3.0 且 jdk > 17

jdk = 17
spring boot = 3.5.4

导入依赖

在pom.xml文件中导入以下依赖：

<!-- 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>
    <version>4.5.0</version>
</dependency>

导入配置

/**
 *  knife4j接口文档配置
 */
@Configuration
public class SwaggerConfig implements WebMvcConfigurer {

    @Value("xxx")
    private String applicationName;

    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .components(new Components()
                        .addParameters("token",new HeaderParameter().description("请填写Token").schema(new StringSchema()))
                        .addParameters("adminID",new HeaderParameter().description("请填写用户ID").schema(new StringSchema())))
                .info(new Info().title(applicationName)
                        .description("Knife4j增强文档")
                        .version("v3.0")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("二饭快速开发框架")
                        .url("https://gitee.com/StandFast"));
    }
}