如何将RestDocs生成的本地OpenAPI文件加载到本地Swagger中？

1. 配置Swagger UI指向生成的OpenAPI文件 #

根据你使用的Swagger依赖（推荐用springdoc-openapi替代停止维护的springfox），在配置文件中指定OpenAPI文件的访问路径：

• 若使用application.yml：

springdoc:
  swagger-ui:
    # 指向你的OpenAPI文件路径
    url: /docs/openapi.yml
    # 禁用默认的Swagger注解生成的API文档路径
    disable-swagger-default-url: true

• 若使用application.properties：

springdoc.swagger-ui.url=/docs/openapi.yml
springdoc.swagger-ui.disable-swagger-default-url=true

2. 确保OpenAPI文件的静态资源可访问 #

将生成的openapi.yml文件放在Spring Boot默认的静态资源目录下，比如src/main/resources/static/docs/，这样可以通过http://localhost:8081/docs/openapi.yml直接访问到该文件。如果无法访问，检查：

• 静态资源映射是否被自定义配置覆盖
• 文件权限是否正常，确保Spring Boot能读取到该文件

3. 验证OpenAPI文件的格式兼容性 #

虽然能导入Swagger Editor，但仍需确保文件符合**OpenAPI 3.0+**规范（适配Swagger UI 3.x），重点检查：

• YAML缩进是否规范，无语法错误
• OpenAPI版本声明正确（比如openapi: 3.0.3）
• 所有字段的格式符合OpenAPI规范要求

4. 确认依赖版本兼容性 #

确保restdocs-api-spec/restdocs-spec与Spring Boot、springdoc-openapi的版本匹配：

• Spring Boot 3.x 对应 springdoc-openapi v2.x
• Spring Boot 2.x 对应 springdoc-openapi v1.x
  避免版本不匹配导致的解析异常

内容的提问来源于stack exchange，提问作者Francislainy Campos