springbook3整合Swagger

发布于:2025-09-12 ⋅ 阅读:(21) ⋅ 点赞:(0)
  1. 添加依赖(注意版本)
<!-- SpringDoc OpenAPI(Swagger3) -->  
<dependency>  
    <groupId>org.springdoc</groupId>  
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>  
    <version>2.3.0</version>  
</dependency>  
  
<!-- Knife4j 增强 -->  
<dependency>  
    <groupId>com.github.xiaoymin</groupId>  
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>  
    <version>4.4.0</version>  
</dependency>
  1. 添加配置信息

application.properties

# Knife4j  
knife4j.enable=true  
knife4j.openapi.title=Spring Boot 3集成Swagger和Knife4j  
knife4j.openapi.description=这是一个基于Spring Boot 3、Swagger和Knife4j的接口文档  
knife4j.openapi.version=1.0.0  
knife4j.openapi.contact.name=吴优  
knife4j.openapi.contact.email=developer@example.com  
knife4j.setting.language=zh_cn  
knife4j.setting.enable-swagger-models=true  
knife4j.setting.swagger-model-name=模型列表  
  
# SpringDoc  
springdoc.api-docs.enabled=true  
springdoc.api-docs.path=/v3/api-docs  
springdoc.packages-to-scan=com.example.myjava.module.user.controller  
springdoc.paths-to-match=/**
  1. 配置文件SwaggerConfig(可选)
package com.example.myjava.config;  
  
import io.swagger.v3.oas.models.OpenAPI;  
import io.swagger.v3.oas.models.info.Contact;  
import io.swagger.v3.oas.models.info.Info;  
import io.swagger.v3.oas.models.info.License;  
import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
  
@Configuration  
public class SwaggerConfig {  
  
    @Bean  
    public OpenAPI customOpenAPI() {  
        return new OpenAPI()  
                .info(new Info()  
                        .title("API接口文档")  
                        .version("1.0.0")  
                        .description("系统API接口文档,包含所有可用接口的详细信息")  
                        .contact(new Contact()  
                                .name("吴优   ")  
                                .email("developer@example.com")  
                                .url("https://www.example.com"))  
                        .license(new License()  
                                .name("Apache 2.0")  
                                .url("https://www.apache.org/licenses/LICENSE-2.0.html")));  
    }  
}

网站公告

今日签到

点亮在社区的每一天
去签到