package com.ruoyi.common.swagger.config; import java.util.ArrayList; import java.util.List; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("swagger") public class SwaggerProperties { /** * 是否开启swagger */ private Boolean enabled; /** * swagger会解析的包路径 **/ private String basePackage = ""; /** * swagger会解析的url规则 **/ private List basePath = new ArrayList<>(); /** * 在basePath基础上需要排除的url规则 **/ private List excludePath = new ArrayList<>(); /** * 标题 **/ private String title = ""; /** * 描述 **/ private String description = ""; /** * 版本 **/ private String version = ""; /** * 许可证 **/ private String license = ""; /** * 许可证URL **/ private String licenseUrl = ""; /** * 服务条款URL **/ private String termsOfServiceUrl = ""; /** * host信息 **/ private String host = ""; /** * 联系人信息 */ private Contact contact = new Contact(); /** * 全局统一鉴权配置 **/ private Authorization authorization = new Authorization(); public Boolean getEnabled() { return enabled; } public void setEnabled(Boolean enabled) { this.enabled = enabled; } public String getBasePackage() { return basePackage; } public void setBasePackage(String basePackage) { this.basePackage = basePackage; } public List getBasePath() { return basePath; } public void setBasePath(List basePath) { this.basePath = basePath; } public List getExcludePath() { return excludePath; } public void setExcludePath(List excludePath) { this.excludePath = excludePath; } public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } public String getDescription() { return description; } public void setDescription(String description) { this.description = description; } public String getVersion() { return version; } public void setVersion(String version) { this.version = version; } public String getLicense() { return license; } public void setLicense(String license) { this.license = license; } public String getLicenseUrl() { return licenseUrl; } public void setLicenseUrl(String licenseUrl) { this.licenseUrl = licenseUrl; } public String getTermsOfServiceUrl() { return termsOfServiceUrl; } public void setTermsOfServiceUrl(String termsOfServiceUrl) { this.termsOfServiceUrl = termsOfServiceUrl; } public String getHost() { return host; } public void setHost(String host) { this.host = host; } public Contact getContact() { return contact; } public void setContact(Contact contact) { this.contact = contact; } public Authorization getAuthorization() { return authorization; } public void setAuthorization(Authorization authorization) { this.authorization = authorization; } public static class Contact { /** * 联系人 **/ private String name = ""; /** * 联系人url **/ private String url = ""; /** * 联系人email **/ private String email = ""; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } } public static class Authorization { /** * 鉴权策略ID,需要和SecurityReferences ID保持一致 */ private String name = ""; /** * 需要开启鉴权URL的正则 */ private String authRegex = "^.*$"; /** * 鉴权作用域列表 */ private List authorizationScopeList = new ArrayList<>(); private List tokenUrlList = new ArrayList<>(); public String getName() { return name; } public void setName(String name) { this.name = name; } public String getAuthRegex() { return authRegex; } public void setAuthRegex(String authRegex) { this.authRegex = authRegex; } public List getAuthorizationScopeList() { return authorizationScopeList; } public void setAuthorizationScopeList(List authorizationScopeList) { this.authorizationScopeList = authorizationScopeList; } public List getTokenUrlList() { return tokenUrlList; } public void setTokenUrlList(List tokenUrlList) { this.tokenUrlList = tokenUrlList; } } public static class AuthorizationScope { /** * 作用域名称 */ private String scope = ""; /** * 作用域描述 */ private String description = ""; public String getScope() { return scope; } public void setScope(String scope) { this.scope = scope; } public String getDescription() { return description; } public void setDescription(String description) { this.description = description; } } }