记录springboot 3.x 版本整合 swagger

仅以纪念 / 2025-02-18 / 原文

boot版本
3.3.5
jdk版本
17
pom 文件依赖包导入

<dependency>  
    <groupId>org.springdoc</groupId>  
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>  
    <version>2.6.0</version>  
</dependency>

建一个swagger配置文件



@Configuration  
public class SwaggerConfig {  
@Bean  
public OpenAPI openAPI() {  
return new OpenAPI()  
.info(new Info()  
.title("demo接口文档")  
.description("SpringBoot3 集成 Swagger3接口文档")  
.version("v1"))  
.externalDocs(new ExternalDocumentation()  
.description("项目API文档")  
.url("/"));  
}

}

yaml 配置文件写法

springdoc:  
  api-docs:  
    path: /api-docs  
    group: default  
    enabled: true  
  swagger-ui:                 #去掉 url 和 config-url 参数 可以正常访问 加上后需要配置正确路径 (暂时不理解)不然报404错误。  
    path: /swagger-ui.html  
    #base-url: /api  
    enabled: true

配置成功后就可以访问啦

http://localhost:yourPort/api/swagger-ui/index.html (yourPort 你的端口号) 进行访问

参考使用链接 https://blog.csdn.net/xiyang_1990/article/details/140739948