读取swagger配置文件里的内容

最新推荐文章于 2024-05-03 22:35:52 发布

原创最新推荐文章于 2024-05-03 22:35:52 发布 · 1.2k 阅读

1 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#java #spring boot

Spring boot 专栏收录该内容

24 篇文章

订阅专栏

本文档介绍了如何在Spring Boot应用中通过@ConfigurationProperties和@Value注解来读取Swagger的配置信息。首先，在配置文件类中添加Swagger配置，然后创建一个SwaggerProperties类，用于绑定配置属性。SwaggerProperties类包括了如title、description、version等接口文档的关键信息。通过@Autowired或@Value注解，可以在测试类或其他地方获取并打印这些配置，确保能够成功读取Swagger的相关设置。

首先在配置文件类中加入swagger配置：

在这里插入图片描述
接着创建一个properties包，其中有个SwaggerProperties类

/**
 * TODO Swagger类
 *
 * @author DB
 * <br>CreateDate 2021/8/30 11:24
 */

@Component
@ConfigurationProperties(prefix = "swagger")
public class SwaggerProperties {
    private String title;
    private String contactName;
    private String contactUrl;
    private String contactEmail;
    private String version;
    private String description;
    private String basePackageRest;
    private String termsOfServiceUrl;
}
下面加上get、set方法

读取有两种方法：
1.第一种方法
在测试类中：

@Autowired
private SwaggerProperties swaggerProperties;
log.info("Swagger接口文档配置swaggerProperties:{}", swaggerProperties);

结果：
在这里插入图片描述
读取成功

2.第二种方法：

@Value("${swagger.title}")
private String swaggerTitle;

@Value("${swagger.description}")
private String swaggerDescription;

log.info("Swagger接口文档配置swaggerTitle:{}====swaggerDescription:{}", swaggerTitle, swaggerDescription);