如何使用 YAML 文件在 Spring Boot 中配置 Swagger？

Posted 2023-02-26

技术标签:

【中文标题】如何使用 YAML 文件在 Spring Boot 中配置 Swagger？【英文标题】：How to configure Swagger in Spring Boot using YAML file? 【发布时间】：2018-11-29 12:41:31 【问题描述】：

我的 Swagger 配置有问题。现在 Swagger 正在扫描包并创建漂亮的文档，但我想使用我的 YAML（如果无法使用 YAML，则使用 JSON）文件。

这是我的 Swagger 配置类：

@Configuration
@EnableSwagger2
public class SwaggerConfig 
@Bean
public Docket api() 
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.myapp.rest"))
            .paths(PathSelectors.any())
            .build();

我想在 YAML 文件中编写使用示例，以便 Swagger 可以显示它们。如何更改/添加配置让 Swagger 获取我的 YAML 文件？

【问题讨论】：

【参考方案1】：

您可以下载 Swagger UI 并将其放置在您的项目中，将 URL 更改为指向 YAML 文件。