Spring项目中Swagger地址如何查看？启动后接口文档地址在哪？

Question

在Spring项目中，如何正确访问Swagger生成的接口文档地址是开发人员常遇到的问题。首先确保项目已引入Swagger相关依赖（如`springfox-boot-starter`或`io.springfox:springfox-swagger2`）。启动项目后，默认情况下，Swagger的接口文档页面可通过`http://localhost:/swagger-ui.html`访问（新版本可能是`/swagger-ui/index.html`）。如果找不到该地址，可能是因为配置文件中未启用Swagger或路径被自定义修改。 检查以下几点： 1. 确保`@EnableSwagger2`注解已添加到配置类（新版本可使用`@Bean`注册`Docket`）。 2. 配置文件中是否设置了`springfox.documentation.enabled=true`。 3. 检查是否存在路径映射规则更改。 若仍无法访问，请核对依赖版本与Spring Boot兼容性。此外，API文档数据可通过`http://localhost:/v2/api-docs`直接获取JSON格式内容。

Answer 1

1. 初步了解Swagger在Spring项目中的集成

Swagger 是一种流行的 API 文档生成工具，广泛应用于 Spring 项目中。它可以帮助开发人员快速生成 RESTful API 的文档，并提供在线测试功能。

要正确访问 Swagger 生成的接口文档地址，首先需要确保项目已引入相关依赖。以下是常见的依赖项：

• springfox-boot-starter
• io.springfox:springfox-swagger2

启动项目后，默认情况下可以通过以下地址访问 Swagger UI 页面：

• http://localhost:<port>/swagger-ui.html（旧版本）
• http://localhost:<port>/swagger-ui/index.html（新版本）

2. 常见问题分析与解决方案

如果无法访问 Swagger 接口文档页面，可以按照以下步骤进行排查：

1. 检查是否添加了 @EnableSwagger2 注解到配置类中。如果是新版本，建议使用 @Bean 注册 Docket 实例。
2. 确认配置文件中是否设置了 springfox.documentation.enabled=true。
3. 检查是否存在路径映射规则的修改，例如自定义的拦截器或过滤器。

以下是一个典型的 Docket 配置示例：

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

3. 深入探讨：依赖版本与兼容性

如果上述步骤均未发现问题，但仍无法访问 Swagger 页面，可能是因为依赖版本与 Spring Boot 版本不兼容。以下表格列出了常见版本的兼容关系：

Spring Boot 版本	Springfox 版本
2.3.x	3.0.0
2.5.x	3.0.0
2.7.x	3.0.0

此外，API 文档数据可以通过以下 URL 获取 JSON 格式的内容：

http://localhost:<port>/v2/api-docs

4. 流程图：排查步骤可视化

为了更清晰地展示排查步骤，以下是一个流程图：

graph TD;
            A[无法访问 Swagger 页面] --> B{是否添加注解};
            B --否--> C{是否启用配置};
            C --否--> D{路径映射是否更改};
            D --否--> E{依赖版本是否匹配};
            E --否--> F[检查其他问题];