让Springboot拥抱Swagger2：从404页面到API文档

后端

2023-11-07 23:30:04

Springboot集成Swagger2：解决"swagger-resources 404"错误

问题分析

在Springboot项目中，集成Swagger2时，可能会遇到"swagger-resources 404/swagger-resources/configuration/ui 404"错误。这是由于以下原因造成的：

配置错误： Swagger2配置有误或不完整，无法正确加载资源。
版本不兼容： Swagger2版本与Springboot版本不兼容。
资源路径错误： Swagger2资源的URL路径配置不正确。
未添加注解： 启动类上缺少@EnableSwagger2注解。

解决方案

1. 检查配置

仔细检查Swagger2配置，确保已添加所有必要的依赖项，并且配置正确。

2. 确认版本

确保Swagger2版本与Springboot版本兼容。

3. 配置资源路径

在Springboot项目中，使用@RequestMapping注解配置Swagger2资源的URL路径。确保路径配置正确。

4. 添加注解

在启动类上添加@EnableSwagger2注解，以启用Swagger2。

示例代码

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Springboot集成Swagger2 API文档")
                .description("Springboot集成Swagger2 API文档")
                .version("1.0")
                .build();
    }
}