程序包 com.github.xiaoymin.knife4j.core.extend

类 OpenApiExtendSetting

  • public class OpenApiExtendSetting
extends java.lang.Object
    作者:
    xiaoymin@foxmail.com 2020/10/24 6:56

    • 字段详细资料

      • language

        private java.lang.String language
        Ui语言版本

      • enableSwaggerModels

        private boolean enableSwaggerModels
        是否显示界面中SwaggerModel功能

      • swaggerModelName

        private java.lang.String swaggerModelName
        重命名SwaggerModel名称,默认

      • enableReloadCacheParameter

        private boolean enableReloadCacheParameter
        是否在每个Debug调试栏后显示刷新变量按钮,默认不显示

      • enableAfterScript

        private boolean enableAfterScript
        调试Tab是否显示AfterScript功能,默认开启

      • enableDocumentManage

        private boolean enableDocumentManage
        是否显示界面中"文档管理"功能

      • enableVersion

        private boolean enableVersion
        是否开启界面中对某接口的版本控制,如果开启，后端变化后Ui界面会存在小蓝点

      • enableRequestCache

        private boolean enableRequestCache
        是否开启请求参数缓存

      • enableFilterMultipartApis

        private boolean enableFilterMultipartApis
        针对RequestMapping的接口请求类型,在不指定参数类型的情况下,如果不过滤,默认会显示7个类型的接口地址参数,如果开启此配置,默认展示一个Post类型的接口地址

      • enableFilterMultipartApiMethodType

        private java.lang.String enableFilterMultipartApiMethodType
        过滤类型

      • enableHost

        private boolean enableHost
        是否启用Host

      • enableHostText

        private java.lang.String enableHostText
        启用Host后文本

      • enableDynamicParameter

        private boolean enableDynamicParameter
        是否开启动态请求参数

      • enableDebug

        private boolean enableDebug
        是否开启debug调试

      • enableFooter

        private boolean enableFooter
        是否默认显示底部Footer

      • enableFooterCustom

        private boolean enableFooterCustom
        是否自定义Footer

      • footerCustomContent

        private java.lang.String footerCustomContent
        自定义Footer内容(支持Markdown语法)

      • enableSearch

        private boolean enableSearch
        是否显示搜索框

      • enableOpenApi

        private boolean enableOpenApi
        是否显示OpenAPI原始结构的Tab框，默认显示

      • enableHomeCustom

        private boolean enableHomeCustom
        是否开启主页自定义配置，默认false

      • homeCustomLocation

        private java.lang.String homeCustomLocation
        自定义主页的Markdown文档路径

      • enableGroup

        private boolean enableGroup
        是否显示分组下拉框，默认true(即显示)，一般情况下，如果是单个分组的情况下，可以设置该属性为false，即不显示分组，那么也就不用选择了

      • enableResponseCode

        private boolean enableResponseCode
        是否显示响应状态码栏 https://gitee.com/xiaoym/knife4j/issues/I3TE0V
        从以下版本开始:
        v4.0.0

    • 构造器详细资料

      • OpenApiExtendSetting

        public OpenApiExtendSetting()

    • 方法详细资料

      • isEnableResponseCode

        public boolean isEnableResponseCode()

      • setEnableResponseCode

        public void setEnableResponseCode​(boolean enableResponseCode)

      • isEnableGroup

        public boolean isEnableGroup()

      • setEnableGroup

        public void setEnableGroup​(boolean enableGroup)

      • getLanguage

        public java.lang.String getLanguage()

      • setLanguage

        public void setLanguage​(java.lang.String language)

      • isEnableRequestCache

        public boolean isEnableRequestCache()

      • setEnableRequestCache

        public void setEnableRequestCache​(boolean enableRequestCache)

      • isEnableFilterMultipartApis

        public boolean isEnableFilterMultipartApis()

      • setEnableFilterMultipartApis

        public void setEnableFilterMultipartApis​(boolean enableFilterMultipartApis)

      • getEnableFilterMultipartApiMethodType

        public java.lang.String getEnableFilterMultipartApiMethodType()

      • setEnableFilterMultipartApiMethodType

        public void setEnableFilterMultipartApiMethodType​(java.lang.String enableFilterMultipartApiMethodType)

      • isEnableHost

        public boolean isEnableHost()

      • setEnableHost

        public void setEnableHost​(boolean enableHost)

      • getEnableHostText

        public java.lang.String getEnableHostText()

      • setEnableHostText

        public void setEnableHostText​(java.lang.String enableHostText)

      • isEnableSwaggerModels

        public boolean isEnableSwaggerModels()

      • setEnableSwaggerModels

        public void setEnableSwaggerModels​(boolean enableSwaggerModels)

      • isEnableDocumentManage

        public boolean isEnableDocumentManage()

      • setEnableDocumentManage

        public void setEnableDocumentManage​(boolean enableDocumentManage)

      • isEnableVersion

        public boolean isEnableVersion()

      • setEnableVersion

        public void setEnableVersion​(boolean enableVersion)

      • getSwaggerModelName

        public java.lang.String getSwaggerModelName()

      • setSwaggerModelName

        public void setSwaggerModelName​(java.lang.String swaggerModelName)

      • isEnableAfterScript

        public boolean isEnableAfterScript()

      • setEnableAfterScript

        public void setEnableAfterScript​(boolean enableAfterScript)

      • isEnableReloadCacheParameter

        public boolean isEnableReloadCacheParameter()

      • setEnableReloadCacheParameter

        public void setEnableReloadCacheParameter​(boolean enableReloadCacheParameter)

      • isEnableDynamicParameter

        public boolean isEnableDynamicParameter()

      • setEnableDynamicParameter

        public void setEnableDynamicParameter​(boolean enableDynamicParameter)

      • isEnableDebug

        public boolean isEnableDebug()

      • setEnableDebug

        public void setEnableDebug​(boolean enableDebug)

      • isEnableFooter

        public boolean isEnableFooter()

      • setEnableFooter

        public void setEnableFooter​(boolean enableFooter)

      • isEnableFooterCustom

        public boolean isEnableFooterCustom()

      • setEnableFooterCustom

        public void setEnableFooterCustom​(boolean enableFooterCustom)

      • getFooterCustomContent

        public java.lang.String getFooterCustomContent()

      • setFooterCustomContent

        public void setFooterCustomContent​(java.lang.String footerCustomContent)

      • isEnableSearch

        public boolean isEnableSearch()

      • setEnableSearch

        public void setEnableSearch​(boolean enableSearch)

      • isEnableOpenApi

        public boolean isEnableOpenApi()

      • setEnableOpenApi

        public void setEnableOpenApi​(boolean enableOpenApi)

      • isEnableHomeCustom

        public boolean isEnableHomeCustom()

      • setEnableHomeCustom

        public void setEnableHomeCustom​(boolean enableHomeCustom)

      • getHomeCustomLocation

        public java.lang.String getHomeCustomLocation()

      • setHomeCustomLocation

        public void setHomeCustomLocation​(java.lang.String homeCustomLocation)