com.spring4all.swagger.SwaggerProperties Maven / Gradle / Ivy
package com.spring4all.swagger;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.context.properties.ConfigurationProperties;
import springfox.documentation.swagger.web.DocExpansion;
import springfox.documentation.swagger.web.ModelRendering;
import springfox.documentation.swagger.web.OperationsSorter;
import springfox.documentation.swagger.web.TagsSorter;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* @author 翟永超
* Create date ：2017/8/7.
* My blog： http://blog.didispace.com
*/
@Data
@ConfigurationProperties("swagger")
public class SwaggerProperties {
/**
* 是否开启swagger
**/
private Boolean enabled;
/**
* 标题
**/
private String title = "";
/**
* 描述
**/
private String description = "";
/**
* 版本
**/
private String version = "";
/**
* 许可证
**/
private String license = "";
/**
* 许可证URL
**/
private String licenseUrl = "";
/**
* 服务条款URL
**/
private String termsOfServiceUrl = "";
/**
* 忽略的参数类型
**/
private List> ignoredParameterTypes = new ArrayList<>();
private Contact contact = new Contact();
/**
* swagger会解析的包路径
**/
private String basePackage = "";
/**
* swagger会解析的url规则
**/
private List basePath = new ArrayList<>();
/**
* 在basePath基础上需要排除的url规则
**/
private List excludePath = new ArrayList<>();
/**
* 分组文档
**/
private Map docket = new LinkedHashMap<>();
/**
* host信息
**/
private String host = "";
/**
* 全局参数配置
**/
private List globalOperationParameters;
/**
* 页面功能配置
**/
private UiConfig uiConfig = new UiConfig();
/**
* 是否使用默认预定义的响应消息 ，默认 true
**/
private Boolean applyDefaultResponseMessages = true;
/**
* 全局响应消息
**/
private GlobalResponseMessage globalResponseMessage;
/**
* 全局统一鉴权配置
**/
private Authorization authorization = new Authorization();
@Data
@NoArgsConstructor
public static class GlobalOperationParameter {
/**
* 参数名
**/
private String name;
/**
* 描述信息
**/
private String description;
/**
* 指定参数类型
**/
private String modelRef;
/**
* 参数放在哪个地方:header,query,path,body.form
**/
private String parameterType;
/**
* 参数是否必须传
**/
private String required;
}
@Data
@NoArgsConstructor
public static class DocketInfo {
/**
* 标题
**/
private String title = "";
/**
* 描述
**/
private String description = "";
/**
* 版本
**/
private String version = "";
/**
* 许可证
**/
private String license = "";
/**
* 许可证URL
**/
private String licenseUrl = "";
/**
* 服务条款URL
**/
private String termsOfServiceUrl = "";
private Contact contact = new Contact();
/**
* swagger会解析的包路径
**/
private String basePackage = "";
/**
* swagger会解析的url规则
**/
private List basePath = new ArrayList<>();
/**
* 在basePath基础上需要排除的url规则
**/
private List excludePath = new ArrayList<>();
private List globalOperationParameters;
/**
* 忽略的参数类型
**/
private List> ignoredParameterTypes = new ArrayList<>();
}
@Data
@NoArgsConstructor
public static class Contact {
/**
* 联系人
**/
private String name = "";
/**
* 联系人url
**/
private String url = "";
/**
* 联系人email
**/
private String email = "";
}
@Data
@NoArgsConstructor
public static class GlobalResponseMessage {
/**
* POST 响应消息体
**/
List post = new ArrayList<>();
/**
* GET 响应消息体
**/
List get = new ArrayList<>();
/**
* PUT 响应消息体
**/
List put = new ArrayList<>();
/**
* PATCH 响应消息体
**/
List patch = new ArrayList<>();
/**
* DELETE 响应消息体
**/
List delete = new ArrayList<>();
/**
* HEAD 响应消息体
**/
List head = new ArrayList<>();
/**
* OPTIONS 响应消息体
**/
List options = new ArrayList<>();
/**
* TRACE 响应消息体
**/
List trace = new ArrayList<>();
}
@Data
@NoArgsConstructor
public static class GlobalResponseMessageBody {
/**
* 响应码
**/
private int code;
/**
* 响应消息
**/
private String message;
/**
* 响应体
**/
private String modelRef;
}
@Data
@NoArgsConstructor
public static class UiConfig {
private String apiSorter = "alpha";
/**
* 是否启用json编辑器
**/
private Boolean jsonEditor = false;
/**
* 是否显示请求头信息
**/
private Boolean showRequestHeaders = true;
/**
* 支持页面提交的请求类型
**/
private String submitMethods = "get,post,put,delete,patch";
/**
* 请求超时时间
**/
private Long requestTimeout = 10000L;
private Boolean deepLinking;
private Boolean displayOperationId;
private Integer defaultModelsExpandDepth;
private Integer defaultModelExpandDepth;
private ModelRendering defaultModelRendering;
/**
* 是否显示请求耗时，默认false
*/
private Boolean displayRequestDuration = true;
/**
* 可选 none | list
*/
private DocExpansion docExpansion;
/**
* Boolean=false OR String
*/
private Object filter;
private Integer maxDisplayedTags;
private OperationsSorter operationsSorter;
private Boolean showExtensions;
private TagsSorter tagsSorter;
/**
* Network
*/
private String validatorUrl;
}
/**
* securitySchemes 支持方式之一 ApiKey
*/
@Data
@NoArgsConstructor
static class Authorization {
/**
* 鉴权策略ID，对应 SecurityReferences ID
*/
private String name = "Authorization";
/**
* 鉴权策略，可选 ApiKey | BasicAuth | None，默认ApiKey
*/
private String type = "ApiKey";
/**
* 鉴权传递的Header参数
*/
private String keyName = "TOKEN";
/**
* 需要开启鉴权URL的正则
*/
private String authRegex = "^.*$";
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy