com.github.xiaoymin.knife4j.spring.configuration.Knife4jProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of knife4j-openapi3-spring-boot-starter Show documentation

Spring Boot autoconfigure

There is a newer version: 4.5.0

Show newest version

/*
 * Copyright © 2017-2023 Knife4j([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.github.xiaoymin.knife4j.spring.configuration;

import com.github.xiaoymin.knife4j.core.model.MarkdownProperty;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

/***
 * 配置文件
 * @since  1.9.6
 * @author [email protected] 
 * 2019/08/27 15:40
 */
@Data
@Component
@ConfigurationProperties(prefix = "knife4j")
public class Knife4jProperties {
    
    /**
     * 是否开启Knife4j增强模式
     */
    private boolean enable = false;
    /**
     * 是否开启默认跨域
     */
    private boolean cors = false;
    
    /**
     * 是否开启BasicHttp验证
     */
    private Knife4jHttpBasic basic;
    
    /**
     * 是否生产环境
     */
    private boolean production = false;
    
    /**
     * 个性化配置
     */
    private Knife4jSetting setting;
    
    /**
     * 分组文档集合
     */
    private List documents;
    
}