索引

A B C D E F G H I J K M N O P R S T U V W Z 
All Classes and Interfaces|常量字段值|所有程序包

A

AbstractSecurityFilter - com.github.xiaoymin.knife4j.extend.filter.basic中的类
 
AbstractSecurityFilter() - 类的构造器 com.github.xiaoymin.knife4j.extend.filter.basic.AbstractSecurityFilter
 
addRoute(Knife4jInsightRoute) - 类中的方法 com.github.xiaoymin.knife4j.insight.Knife4jInsightDiscoveryInfo
 
addRule(String) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.BasicFilter
添加外部过滤规则,正则表达式
addRule(Collection<String>) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.BasicFilter
添加外部过滤规则,正则表达式
ANNOTATION - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.ApiRuleEnums
annotation,see AnnotationClassEnums
AnnotationCacheKey - com.github.xiaoymin.knife4j.core.model中的类
 
AnnotationCacheKey(AnnotatedElement, Class<? extends Annotation>) - 类的构造器 com.github.xiaoymin.knife4j.core.model.AnnotationCacheKey
 
AnnotationClassEnums - com.github.xiaoymin.knife4j.core.enums中的Enum Class
 
AnnotationUtils - com.github.xiaoymin.knife4j.core.util中的类
 
AnnotationUtils() - 类的构造器 com.github.xiaoymin.knife4j.core.util.AnnotationUtils
 
ANT - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.PathRuleEnums
group with ant path matcher
Api - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
ShortName with @Api Swagger2
API_KEY - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.BasicAuthTypeEnums
自定义header请求头
ApiOperation - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 
ApiOperationSort - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
已过时。
ApiOperationSupport - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
Help Java development engineers build powerful Swagger documents
ApiRuleEnums - com.github.xiaoymin.knife4j.core.enums中的Enum Class
 
ApiSort - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
Deprecated since 2.0.3,see ApiSupport
ApiSupport - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
Help Java development engineers build powerful Swagger documents
Assert - com.github.xiaoymin.knife4j.core.util中的类
 
Assert() - 类的构造器 com.github.xiaoymin.knife4j.core.util.Assert
 
AUTH_HEADER_NAME - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
校验Basic请求头
author() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSupport
author
author() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiSupport
author
AUTHORIZATION_CODE - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.OAuth2TypeEnums
OAuth2 - authorization_code
authors() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSupport
作者,提供数组形式以展示多个,会和ApiOperationSupport.author()进行合并展示
authors() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiSupport
作者,提供数组形式以展示多个,会和ApiSupport.author()进行合并展示

B

BASE_PACKAGE_PREFIX - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
动态生成class包名前缀
BASIC - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.BasicAuthTypeEnums
basic
BASIC_DEFAULT_PASSWORD - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
Knife4j provider default password with basic auth.
BASIC_DEFAULT_USERNAME - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
Knife4j provider default username with basic auth.
BASIC_SECURITY_RESPONSE_CODE - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
响应HTTP状态码
BasicAuthTypeEnums - com.github.xiaoymin.knife4j.core.enums中的Enum Class
 
BasicFilter - com.github.xiaoymin.knife4j.extend.filter中的类
 
BasicFilter() - 类的构造器 com.github.xiaoymin.knife4j.extend.filter.BasicFilter
 

C

CLIENT_CREDENTIALS - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.OAuth2TypeEnums
OAuth2 - client_credentials
close(InputStream) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
close(OutputStream) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
close(Reader) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
CollectionUtils - com.github.xiaoymin.knife4j.core.util中的类
 
CollectionUtils() - 类的构造器 com.github.xiaoymin.knife4j.core.util.CollectionUtils
 
com.github.xiaoymin.knife4j.annotations - 程序包 com.github.xiaoymin.knife4j.annotations
 
com.github.xiaoymin.knife4j.core - 程序包 com.github.xiaoymin.knife4j.core
 
com.github.xiaoymin.knife4j.core.conf - 程序包 com.github.xiaoymin.knife4j.core.conf
 
com.github.xiaoymin.knife4j.core.enums - 程序包 com.github.xiaoymin.knife4j.core.enums
 
com.github.xiaoymin.knife4j.core.extend - 程序包 com.github.xiaoymin.knife4j.core.extend
 
com.github.xiaoymin.knife4j.core.model - 程序包 com.github.xiaoymin.knife4j.core.model
 
com.github.xiaoymin.knife4j.core.oauth2 - 程序包 com.github.xiaoymin.knife4j.core.oauth2
 
com.github.xiaoymin.knife4j.core.util - 程序包 com.github.xiaoymin.knife4j.core.util
 
com.github.xiaoymin.knife4j.extend.filter - 程序包 com.github.xiaoymin.knife4j.extend.filter
 
com.github.xiaoymin.knife4j.extend.filter.basic - 程序包 com.github.xiaoymin.knife4j.extend.filter.basic
 
com.github.xiaoymin.knife4j.extend.util - 程序包 com.github.xiaoymin.knife4j.extend.util
 
com.github.xiaoymin.knife4j.insight - 程序包 com.github.xiaoymin.knife4j.insight
 
com.github.xiaoymin.knife4j.insight.config - 程序包 com.github.xiaoymin.knife4j.insight.config
 
com.github.xiaoymin.knife4j.insight.openapi3 - 程序包 com.github.xiaoymin.knife4j.insight.openapi3
 
com.github.xiaoymin.knife4j.insight.upload - 程序包 com.github.xiaoymin.knife4j.insight.upload
 
CommonUtils - com.github.xiaoymin.knife4j.core.util中的类
 
CommonUtils() - 类的构造器 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
compareTo(AnnotationCacheKey) - 类中的方法 com.github.xiaoymin.knife4j.core.model.AnnotationCacheKey
 
Controller - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 
CORS_MAX_AGE - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
Cors max_age

D

dataTypeClass() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicParameter
The class of the parameter.
decodeBase64(String) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.BasicFilter
 
DeleteMapping - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 
destroy() - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.JakartaServletSecurityBasicAuthFilter
 
destroy() - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.ServletSecurityBasicAuthFilter
 
doFilter(ServletRequest, ServletResponse, FilterChain) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.JakartaServletSecurityBasicAuthFilter
 
doFilter(ServletRequest, ServletResponse, FilterChain) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.ServletSecurityBasicAuthFilter
 
DynamicClass - com.github.xiaoymin.knife4j.core.model中的类
 
DynamicClass() - 类的构造器 com.github.xiaoymin.knife4j.core.model.DynamicClass
 
DynamicParameter - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
Note: 自Knife4j 4.0版本起,功能保留,但目前阶段放弃维护此属性值,建议开发者建实体类,后续有迭代在更新
DynamicParameters - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
Note: 自Knife4j 4.0版本起,功能保留,但目前阶段放弃维护此属性值,建议开发者建实体类,后续有迭代在更新
DynamicResponseParameters - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
Note: 自Knife4j 4.0版本起,功能保留,但目前阶段放弃维护此属性值,建议开发者建实体类,后续有迭代在更新

E

EMPTY_STR - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
空字符串
EN - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.OpenAPILanguageEnums
English
equals(Object) - 类中的方法 com.github.xiaoymin.knife4j.core.model.AnnotationCacheKey
 
example() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicParameter
a single example for non-body type parameters
EXTENSION_AUTHOR - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.ExtensionsConstants
作者
EXTENSION_NAME - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
Knife4j增强扩展属性名称
EXTENSION_OPEN_API_NAME - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
Knife4j增强扩展属性名称
EXTENSION_OPEN_MARKDOWN_NAME - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
Knife4j增强扩展配置属性
EXTENSION_OPEN_SETTING_NAME - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
Knife4j增强扩展配置属性
EXTENSION_ORDER - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.ExtensionsConstants
排序
ExtensionsConstants - com.github.xiaoymin.knife4j.core.conf中的类
 
ExtensionsConstants() - 类的构造器 com.github.xiaoymin.knife4j.core.conf.ExtensionsConstants
 
ExtensionUtils - com.github.xiaoymin.knife4j.extend.util中的类
 
ExtensionUtils() - 类的构造器 com.github.xiaoymin.knife4j.extend.util.ExtensionUtils
 

F

FilterUtils - com.github.xiaoymin.knife4j.extend.util中的类
 
FilterUtils() - 类的构造器 com.github.xiaoymin.knife4j.extend.util.FilterUtils
 
findAnnotation(Class<?>, Class<A>) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.AnnotationUtils
查找注解
findAnnotation(Class<?>, Class<A>, boolean) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.AnnotationUtils
 
FORBIDDEN_CUSTOM_CODE - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
生产环境屏蔽后自定义响应HTTP状态码

G

genSupperName(String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
首字母大写
get(String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Knife4jUtils
 
getAuthor(ApiSupport) - 类中的静态方法 com.github.xiaoymin.knife4j.extend.util.ExtensionUtils
 
getAuthors(ApiOperationSupport) - 类中的静态方法 com.github.xiaoymin.knife4j.extend.util.ExtensionUtils
获取作者
getConcat() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getContent() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownChildren
 
getDebugUri(String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
getDescription() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getDescription() - 类中的方法 com.github.xiaoymin.knife4j.core.model.SortModel
 
getEmail() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getEnableFilterMultipartApiMethodType() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
getEnableHostText() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
getFieldClazz() - 类中的方法 com.github.xiaoymin.knife4j.core.model.DynamicClass
 
getFooterCustomContent() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
getGroup() - 类中的方法 com.github.xiaoymin.knife4j.core.model.MarkdownProperty
 
getGroupName() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtend
 
getHomeCustomLocation() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
getLanguage() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
getLicense() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getLicenseUrl() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getLocations() - 类中的方法 com.github.xiaoymin.knife4j.core.model.MarkdownProperty
 
GetMapping - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 
getMarkdownFiles() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtend
 
getMethod() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OperationSortModel
 
getName() - 类中的方法 com.github.xiaoymin.knife4j.core.model.MarkdownProperty
 
getName() - 类中的方法 com.github.xiaoymin.knife4j.core.model.SortModel
 
getOpenApiExtendSetting() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtend
 
getRandomBeanName(String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
getRetry(String, int) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Knife4jUtils
 
getSort() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OperationSortModel
 
getSort() - 类中的方法 com.github.xiaoymin.knife4j.core.model.SortModel
 
getSwaggerModelName() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
getTargetClazz() - 类中的方法 com.github.xiaoymin.knife4j.core.model.DynamicClass
 
getTermsOfServiceUrl() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getTitle() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownChildren
 
getTitle() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getUrl() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
getUrl() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OperationSortModel
 
GetUrl(String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Knife4jUtils
 
getUrlFilters() - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.BasicFilter
 
getValue() - enum class中的方法 com.github.xiaoymin.knife4j.core.enums.OpenAPILanguageEnums
 
getVersion() - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
GlobalConstants - com.github.xiaoymin.knife4j.core.conf中的类
 
GlobalConstants() - 类的构造器 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
 

H

hashCode() - 类中的方法 com.github.xiaoymin.knife4j.core.model.AnnotationCacheKey
 

I

Ignore - com.github.xiaoymin.knife4j.annotations中的Annotation Interface
 
ignoreParameters() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSupport
请求忽略参数数组
IMPLICIT - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.OAuth2TypeEnums
OAuth2 - implicit
includeParameters() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSupport
请求接口包含的参数数组,和ignoreParameters属性对立 Note: 自Knife4j 4.0版本起,放弃维护此属性值,建议开发者建实体类
init(FilterConfig) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.JakartaServletSecurityBasicAuthFilter
 
init(FilterConfig) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.ServletSecurityBasicAuthFilter
 
initServletConfig(Enumeration<String>, String, String, String) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.AbstractSecurityFilter
// SpringMVC环境中,由此init方法初始化此Filter,SpringBoot环境中则不同
InsightConstants - com.github.xiaoymin.knife4j.insight中的类
 
InsightConstants() - 类的构造器 com.github.xiaoymin.knife4j.insight.InsightConstants
 
isBlank(CharSequence) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.StrUtil
 
isBlankChar(int) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.StrUtil
 
isEmpty(Object...) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CollectionUtils
是否为空
isEmpty(Collection<?>) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CollectionUtils
判断集合是否为空
isEnableAfterScript() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableDebug() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableDocumentManage() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableDynamicParameter() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableFilterMultipartApis() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableFooter() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableFooterCustom() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableGroup() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableHomeCustom() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableHost() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableOpenApi() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableReloadCacheParameter() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableRequestCache() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableResponseCode() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableSearch() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableSwaggerModels() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isEnableVersion() - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
isNotBlank(CharSequence) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.StrUtil
 
isNotEmpty(Collection<?>) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CollectionUtils
判断集合是否非空
isNotEmpty(Map<?, ?>) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CollectionUtils
 
isTrue(boolean, String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Assert
 

J

JakartaServletSecurityBasicAuthFilter - com.github.xiaoymin.knife4j.extend.filter.basic中的类
 
JakartaServletSecurityBasicAuthFilter() - 类的构造器 com.github.xiaoymin.knife4j.extend.filter.basic.JakartaServletSecurityBasicAuthFilter
 

K

KNIFE4J_BASIC_AUTH_SESSION - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
basic auth验证
KNIFE4J_CLOUD_API - 类中的静态变量 com.github.xiaoymin.knife4j.insight.InsightConstants
 
Knife4jInsightCommonInfo - com.github.xiaoymin.knife4j.insight.config中的类
 
Knife4jInsightCommonInfo() - 类的构造器 com.github.xiaoymin.knife4j.insight.config.Knife4jInsightCommonInfo
 
Knife4jInsightDiscoveryInfo - com.github.xiaoymin.knife4j.insight中的类
 
Knife4jInsightDiscoveryInfo() - 类的构造器 com.github.xiaoymin.knife4j.insight.Knife4jInsightDiscoveryInfo
 
Knife4jInsightOpenAPI3Config - com.github.xiaoymin.knife4j.insight.openapi3中的类
 
Knife4jInsightOpenAPI3Config() - 类的构造器 com.github.xiaoymin.knife4j.insight.openapi3.Knife4jInsightOpenAPI3Config
 
Knife4jInsightOpenAPI3Route - com.github.xiaoymin.knife4j.insight.openapi3中的类
 
Knife4jInsightOpenAPI3Route() - 类的构造器 com.github.xiaoymin.knife4j.insight.openapi3.Knife4jInsightOpenAPI3Route
 
Knife4jInsightRoute - com.github.xiaoymin.knife4j.insight中的类
 
Knife4jInsightRoute() - 类的构造器 com.github.xiaoymin.knife4j.insight.Knife4jInsightRoute
 
Knife4jInsightUploader - com.github.xiaoymin.knife4j.insight.upload中的类
 
Knife4jInsightUploader() - 类的构造器 com.github.xiaoymin.knife4j.insight.upload.Knife4jInsightUploader
 
Knife4jInsightUploadRunner - com.github.xiaoymin.knife4j.insight.upload中的类
 
Knife4jInsightUploadRunner() - 类的构造器 com.github.xiaoymin.knife4j.insight.upload.Knife4jInsightUploadRunner
 
Knife4jUtils - com.github.xiaoymin.knife4j.core.util中的类
 
Knife4jUtils() - 类的构造器 com.github.xiaoymin.knife4j.core.util.Knife4jUtils
 

M

main(String[]) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
main(String[]) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Knife4jUtils
 
MarkdownProperty - com.github.xiaoymin.knife4j.core.model中的类
 
MarkdownProperty() - 类的构造器 com.github.xiaoymin.knife4j.core.model.MarkdownProperty
 
match(String) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.BasicFilter
 

N

name() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicParameter
Name of the parameter.
name() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicParameters
dynamic Model name
name() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicResponseParameters
dynamic Model name
newArrayList(T...) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CollectionUtils
根据数组对象初始化集合
notBlank(String, String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Assert
 
notNull(Object, String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Assert
 

O

OAuth2Info - com.github.xiaoymin.knife4j.core.oauth2中的类
 
OAuth2Info() - 类的构造器 com.github.xiaoymin.knife4j.core.oauth2.OAuth2Info
 
OAuth2Properties - com.github.xiaoymin.knife4j.core.oauth2中的类
 
OAuth2Properties() - 类的构造器 com.github.xiaoymin.knife4j.core.oauth2.OAuth2Properties
 
OAuth2Scope - com.github.xiaoymin.knife4j.core.oauth2中的类
 
OAuth2Scope() - 类的构造器 com.github.xiaoymin.knife4j.core.oauth2.OAuth2Scope
 
OAuth2TypeEnums - com.github.xiaoymin.knife4j.core.enums中的Enum Class
 
OpenApiExtend - com.github.xiaoymin.knife4j.core.extend中的类
此类作为Knife4j提供的增强扩展类
OpenApiExtend() - 类的构造器 com.github.xiaoymin.knife4j.core.extend.OpenApiExtend
 
OpenApiExtendMarkdownChildren - com.github.xiaoymin.knife4j.core.extend中的类
 
OpenApiExtendMarkdownChildren() - 类的构造器 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownChildren
 
OpenApiExtendMarkdownFile - com.github.xiaoymin.knife4j.core.extend中的类
 
OpenApiExtendMarkdownFile() - 类的构造器 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownFile
 
OpenApiExtendSetting - com.github.xiaoymin.knife4j.core.extend中的类
 
OpenApiExtendSetting() - 类的构造器 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
OpenAPIInfo - com.github.xiaoymin.knife4j.core.model中的类
基础配置信息
OpenAPIInfo() - 类的构造器 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
OpenAPILanguageEnums - com.github.xiaoymin.knife4j.core.enums中的Enum Class
 
OperationSortModel - com.github.xiaoymin.knife4j.core.model中的类
 
OperationSortModel() - 类的构造器 com.github.xiaoymin.knife4j.core.model.OperationSortModel
 
order() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSupport
Sort Fields
order() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiSupport
Sort Fields

P

PACKAGE - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.ApiRuleEnums
group with package name
params() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSupport
A list of DynamicParameters available to the API operation.
PASSWORD - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.OAuth2TypeEnums
OAuth2 - password
PatchMapping - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 
PathRuleEnums - com.github.xiaoymin.knife4j.core.enums中的Enum Class
Group policy enumeration with paths
post(String, String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Knife4jUtils
http post
PostMapping - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 
postRetry(String, String, int) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.Knife4jUtils
重试次数
properties() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicParameters
list of properties
properties() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicResponseParameters
list of properties
PROTOCOL_HTTP - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
HTTP Schema
PROTOCOL_HTTPS - 类中的静态变量 com.github.xiaoymin.knife4j.core.conf.GlobalConstants
HTTPS Schema
PutMapping - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 

R

readBytes(File) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
readBytes(InputStream) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
REGEX - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.PathRuleEnums
regex
required() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicParameter
Specifies if the parameter is required or not.
resolveMarkdownTitle(InputStream, String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
Resolve MarkdownFile Content Title
resolveResources(List<String>) - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
处理资源
responses() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSupport
动态构建response响应参数说明 Note: 自Knife4j 4.0版本起,放弃维护此属性值,建议开发者建实体类
RestController - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
 
run() - 类中的方法 com.github.xiaoymin.knife4j.insight.upload.Knife4jInsightUploadRunner
 

S

ServletSecurityBasicAuthFilter - com.github.xiaoymin.knife4j.extend.filter.basic中的类
 
ServletSecurityBasicAuthFilter() - 类的构造器 com.github.xiaoymin.knife4j.extend.filter.basic.ServletSecurityBasicAuthFilter
 
setConcat(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setContent(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownChildren
 
setDescription(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setDescription(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.SortModel
 
setEmail(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setEnableAfterScript(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableDebug(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableDocumentManage(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableDynamicParameter(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableFilterMultipartApiMethodType(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableFilterMultipartApis(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableFooter(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableFooterCustom(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableGroup(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableHomeCustom(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableHost(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableHostText(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableOpenApi(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableReloadCacheParameter(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableRequestCache(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableResponseCode(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableSearch(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableSwaggerModels(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setEnableVersion(boolean) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setFieldClazz(Class<?>) - 类中的方法 com.github.xiaoymin.knife4j.core.model.DynamicClass
 
setFooterCustomContent(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setGroup(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.MarkdownProperty
 
setGroupName(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtend
 
setHomeCustomLocation(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setLanguage(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setLicense(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setLicenseUrl(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setLocations(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.MarkdownProperty
 
setMarkdownFiles(List<OpenApiExtendMarkdownFile>) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtend
 
setMethod(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OperationSortModel
 
setName(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.MarkdownProperty
 
setName(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.SortModel
 
setOpenApiExtendSetting(OpenApiExtendSetting) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtend
 
setSort(Integer) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OperationSortModel
 
setSort(Integer) - 类中的方法 com.github.xiaoymin.knife4j.core.model.SortModel
 
setSwaggerModelName(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting
 
setTargetClazz(Class<?>) - 类中的方法 com.github.xiaoymin.knife4j.core.model.DynamicClass
 
setTermsOfServiceUrl(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setTitle(String) - 类中的方法 com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownChildren
 
setTitle(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setUrl(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
setUrl(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OperationSortModel
 
setVersion(String) - 类中的方法 com.github.xiaoymin.knife4j.core.model.OpenAPIInfo
 
SortModel - com.github.xiaoymin.knife4j.core.model中的类
 
SortModel() - 类的构造器 com.github.xiaoymin.knife4j.core.model.SortModel
 
SPEC_OPENAPI3 - 类中的静态变量 com.github.xiaoymin.knife4j.insight.InsightConstants
 
SPEC_SWAGGER2 - 类中的静态变量 com.github.xiaoymin.knife4j.insight.InsightConstants
 
StrUtil - com.github.xiaoymin.knife4j.core.util中的类
 
StrUtil() - 类的构造器 com.github.xiaoymin.knife4j.core.util.StrUtil
 
SWAGGER_PATH - 类中的静态变量 com.github.xiaoymin.knife4j.insight.InsightConstants
swagger2地址

T

toString() - enum class中的方法 com.github.xiaoymin.knife4j.core.enums.OpenAPILanguageEnums
 
toString() - 类中的方法 com.github.xiaoymin.knife4j.core.model.AnnotationCacheKey
 
tryCommonBasic(String, Object, String) - 类中的方法 com.github.xiaoymin.knife4j.extend.filter.basic.AbstractSecurityFilter
Basic验证

U

upload(Knife4jInsightCommonInfo) - 类中的静态方法 com.github.xiaoymin.knife4j.insight.upload.Knife4jInsightUploader
上传OpenAPI3规范
upperCase(String) - 类中的静态方法 com.github.xiaoymin.knife4j.core.util.CommonUtils
 
urlFilters - 类中的变量 com.github.xiaoymin.knife4j.extend.filter.BasicFilter
 

V

value() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiOperationSort
已过时。
接口排序值
value() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.ApiSort
tag order value, Deprecated since 2.0.3,see ApiSupport order field
value() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.DynamicParameter
A brief description of the parameter.
value() - annotation interface 中的元素 com.github.xiaoymin.knife4j.annotations.Ignore
A brief description of why this parameter/operation is ignored
valueOf(String) - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
Returns the enum constant of this class with the specified name.
valueOf(String) - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.ApiRuleEnums
Returns the enum constant of this class with the specified name.
valueOf(String) - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.BasicAuthTypeEnums
Returns the enum constant of this class with the specified name.
valueOf(String) - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.OAuth2TypeEnums
Returns the enum constant of this class with the specified name.
valueOf(String) - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.OpenAPILanguageEnums
Returns the enum constant of this class with the specified name.
valueOf(String) - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.PathRuleEnums
Returns the enum constant of this class with the specified name.
values() - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums
Returns an array containing the constants of this enum class, in the order they are declared.
values() - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.ApiRuleEnums
Returns an array containing the constants of this enum class, in the order they are declared.
values() - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.BasicAuthTypeEnums
Returns an array containing the constants of this enum class, in the order they are declared.
values() - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.OAuth2TypeEnums
Returns an array containing the constants of this enum class, in the order they are declared.
values() - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.OpenAPILanguageEnums
Returns an array containing the constants of this enum class, in the order they are declared.
values() - enum class中的静态方法 com.github.xiaoymin.knife4j.core.enums.PathRuleEnums
Returns an array containing the constants of this enum class, in the order they are declared.

W

writeForbiddenCode(HttpServletResponse) - 类中的静态方法 com.github.xiaoymin.knife4j.extend.util.FilterUtils
响应Basic信息
writeJakartaForbiddenCode(HttpServletResponse) - 类中的静态方法 com.github.xiaoymin.knife4j.extend.util.FilterUtils
响应Basic

Z

ZH_CN - enum class 中的枚举常量 com.github.xiaoymin.knife4j.core.enums.OpenAPILanguageEnums
Chinese
A B C D E F G H I J K M N O P R S T U V W Z 
All Classes and Interfaces|常量字段值|所有程序包