com.iiifi.kite.boot.properties.KiteSwaggerProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kite-boot Show documentation

Spring Cloud Core Component Extension.

There is a newer version: 1.2.4.RELEASE

package com.iiifi.kite.boot.properties;

import lombok.Getter;
import lombok.Setter;
import java.util.List;
import java.util.ArrayList;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author [email protected] 花朝
 * @date 2018/8/18 13:46
 * @desc Swagger 配置
 */
@Getter
@Setter
@ConfigurationProperties("kite.swagger")
public class KiteSwaggerProperties {

	/**
	 * 是否开启 swagger，默认：true
	 */
	private boolean enabled = true;
	/**
	 * 标题，默认：XXX服务
	 */
	private String title;
	/**
	 * 详情，默认：XXX服务
	 */
	private String description;
	/**
	 * 版本号，默认：V1.0
	 */
	private String version = "V1.0";
	/**
	 * 组织名
	 */
	private String contactUser;
	/**
	 * 组织url
	 */
	private String contactUrl;
	/**
	 * 组织邮箱
	 */
	private String contactEmail;
	/**
	 * 全局统一请求头
	 */
	private final List headers = new ArrayList<>();
	/**
	 * 全局统一鉴权配置
	 **/
	private final Authorization authorization = new Authorization();

	/**
	 * securitySchemes 支持方式之一 ApiKey
	 */
	@Getter
	@Setter
	public static class Authorization {
		/**
		 * 开启Authorization，默认：false
		 */
		private Boolean enabled = false;
		/**
		 * 鉴权策略ID，对应 SecurityReferences ID，默认：Authorization
		 */
		private String name = "Authorization";
		/**
		 * 鉴权传递的Header参数，默认：TOKEN
		 */
		private String keyName = "TOKEN";
		/**
		 * 需要开启鉴权URL的正则，默认：^.*$
		 */
		private String authRegex = "^.*$";
	}

	/**
	 * 全局通用请求头
	 */
	@Getter
	@Setter
	public static class Header {
		/**
		 * 请求头名
		 */
		private String name;
		/**
		 * 请求头描述
		 */
		private String description;
		/**
		 * 是否必须，默认：false
		 */
		private boolean required = false;
	}
}