Spring Boot 3.x 整合Swagger教程

解决Springfox 依赖注入失败问题:

org.springframework.beans.factory.UnsatisfiedDependencyException: 
Error creating bean with name 'apiDocumentationScanner' defined in URL ···

最佳方案是放弃 Springfox 2.x,改用 SpringDoc OpenAPI,因为:

  1. Springfox 2.x 已停止维护

  2. Springfox 3.x 对 Spring Boot 支持有限

  3. SpringDoc 是当前最活跃的 Spring API 文档项目

第一步:添加依赖:


            org.springdoc
            springdoc-openapi-starter-webmvc-ui
            2.5.0
        

第二步:添加配置:

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info()
.title("Spring Boot 中使用 Swagger UI 构建 RESTful API")
                        .contact(new Contact())
                        .description("Sun提供的 RESTful API")
                        .version("v1.0.0")
                        .license(new License().name("Apache 2.0")
.url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("外部文档")
                        .url("https://springshop.wiki.github.org/docs"));
    }
}

 application.properties配置:

springdoc.api-docs.path=/v3/api-docs
springdoc.api-docs.enabled=true

springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.enabled=true

第三步:访问:

http://localhost:8080/swagger-ui.html

你可能感兴趣的:(全栈,spring,boot,java,spring)