索引 (knife4j-spring 2.0.8 API)

A B C D E G I L M O P R S T U

A

AbstractOperationBuilderPlugin - com.github.xiaoymin.knife4j.spring.plugin中的类
AbstractOperationBuilderPlugin() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.AbstractOperationBuilderPlugin
adjustedPath(String) - 类中的方法com.github.xiaoymin.knife4j.spring.common.SwaggerBootstrapUiXForwardPrefixPathAdjuster
ApiAuthorExtension - com.github.xiaoymin.knife4j.spring.extension中的类
ApiAuthorExtension(String) - 类的构造器com.github.xiaoymin.knife4j.spring.extension.ApiAuthorExtension
ApiListingOrderReader - com.github.xiaoymin.knife4j.spring.plugin中的类: 接口排序Plugin
ApiListingOrderReader() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.ApiListingOrderReader
ApiOrderExtension - com.github.xiaoymin.knife4j.spring.extension中的类
ApiOrderExtension(Integer) - 类的构造器com.github.xiaoymin.knife4j.spring.extension.ApiOrderExtension
apply(ApiListingContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.ApiListingOrderReader
apply(ParameterContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.DynamicParameterBuilderPlugin
apply(OperationContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.DynamicResponseModelReader
apply(OperationContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationAuthorBuilderPlugin: 添加作者属性
apply(RequestMappingContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicModelProvider
apply(RequestMappingContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicResponseModelProvider
apply(OperationContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationIgnoreParameterPlugin
apply(OperationContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationOrderBuilderPlugin: 扩展接口的排序规则,添加排序扩展字段 ApiOperationSupport field order ApiOperationSort field value ApiOperation field position ApiOperation - ApiOperationSort - ApioperationSupport

B

BasicFilter - com.github.xiaoymin.knife4j.spring.filter中的类
BasicFilter() - 类的构造器com.github.xiaoymin.knife4j.spring.filter.BasicFilter
buildExtensions(String) - 类中的方法com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver: 构造扩展插件
buildSettingExtensions() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver: 构建个性化增强插件，个性化增强配置无需传递分组名称
ByteUtils - com.github.xiaoymin.knife4j.spring.util中的类
ByteUtils() - 类的构造器com.github.xiaoymin.knife4j.spring.util.ByteUtils

C

com.github.xiaoymin.knife4j.spring.common - 程序包 com.github.xiaoymin.knife4j.spring.common
com.github.xiaoymin.knife4j.spring.extension - 程序包 com.github.xiaoymin.knife4j.spring.extension
com.github.xiaoymin.knife4j.spring.filter - 程序包 com.github.xiaoymin.knife4j.spring.filter
com.github.xiaoymin.knife4j.spring.model - 程序包 com.github.xiaoymin.knife4j.spring.model
com.github.xiaoymin.knife4j.spring.plugin - 程序包 com.github.xiaoymin.knife4j.spring.plugin
com.github.xiaoymin.knife4j.spring.util - 程序包 com.github.xiaoymin.knife4j.spring.util
componentsFrom(HttpServletRequest, String) - 类中的静态方法com.github.xiaoymin.knife4j.spring.common.SwaggerBootstrapUiHostNameProvider
createDynamicModelByOriginalGenericClass(Class<?>, String, DynamicResponseParameters) - 类中的静态方法com.github.xiaoymin.knife4j.spring.util.ByteUtils: 根据原始泛型类创建一个新的Class
createDynamicModelClass(String, DynamicParameter[]) - 类中的静态方法com.github.xiaoymin.knife4j.spring.util.ByteUtils: createModel

D

decodeBase64(String) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.BasicFilter
destroy() - 类中的方法com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter
destroy() - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
DynamicParameterBuilderPlugin - com.github.xiaoymin.knife4j.spring.plugin中的类
DynamicParameterBuilderPlugin() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.DynamicParameterBuilderPlugin
DynamicResponseModelReader - com.github.xiaoymin.knife4j.spring.plugin中的类: 动态替换响应200中的返回Model类,需要注意的是OperationBuilderPlugin有将近30个实现类,其中设置responseMessages属性的有两个实现类，分别是 ResponseMessagesReader：收集接口本身默认返回Model类,添加到responseMessages属性中 SwaggerResponseMessageReader：收集OPen API V2.0规范注解@ApiResponse注解标注的response返回类两个不同的实现类因为SwaggerResponseMessageReader的默认order是在Integer.MAX_VALUE+1000,因此，如果要最后覆盖此属性的话,自定义实现中的Order值需要高于他,否则就会被覆盖.
DynamicResponseModelReader(TypeNameExtractor, EnumTypeDeterminer, SchemaPluginsManager) - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.DynamicResponseModelReader

E

EXTENSION_NAME - 类中的静态变量com.github.xiaoymin.knife4j.spring.extension.OpenApiExtension

G

genClassName(ParameterContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.DynamicParameterBuilderPlugin
genClassName(OperationContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.DynamicResponseModelReader
genClassName(RequestMappingContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicModelProvider
genClassName(RequestMappingContext) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicResponseModelProvider
getAuthor() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiTag
getBasePath() - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFiles
getBeanOfMethod() - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
getBeanType() - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
getDirectory() - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFolder
getErrorMsg() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
getFieldType(Class<?>) - 类中的静态方法com.github.xiaoymin.knife4j.spring.util.ByteUtils
getLocations() - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFolder
getMarkdownFiles() - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFiles
getMarkdownFiles() - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFolder
getMarkdownFiles() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
getMethod() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
getName() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.ApiAuthorExtension
getName() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.ApiOrderExtension
getName() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.OpenApiMarkdownExtension
getName() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.OpenApiSettingExtension
getOrder() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
getOrder() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiTag
getPassword() - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
getPath() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
getPathSortLists() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
getRequestMethods() - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
getSwaggerBootstrapUi() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerExt
getTagSortLists() - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
getUrl() - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
getUrlFilters() - 类中的方法com.github.xiaoymin.knife4j.spring.filter.BasicFilter
getUserName() - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
getValue() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.ApiAuthorExtension
getValue() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.ApiOrderExtension
getValue() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.OpenApiMarkdownExtension
getValue() - 类中的方法com.github.xiaoymin.knife4j.spring.extension.OpenApiSettingExtension

I

IGNORE_PARAMETER_EXTENSION_NAME - 类中的静态变量com.github.xiaoymin.knife4j.spring.plugin.OperationIgnoreParameterPlugin
INCLUDE_PARAMETER_EXTENSION_NAME - 类中的静态变量com.github.xiaoymin.knife4j.spring.plugin.OperationIgnoreParameterPlugin
init(FilterConfig) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter
init(FilterConfig) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
init() - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFiles
isEnableBasicAuth() - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
isProduction() - 类中的方法com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter

L

load(String) - 类中的静态方法com.github.xiaoymin.knife4j.spring.util.ByteUtils

M

MarkdownFiles - com.github.xiaoymin.knife4j.spring.model中的类
MarkdownFiles() - 类的构造器com.github.xiaoymin.knife4j.spring.model.MarkdownFiles
MarkdownFiles(String) - 类的构造器com.github.xiaoymin.knife4j.spring.model.MarkdownFiles
MarkdownFolder - com.github.xiaoymin.knife4j.spring.model中的类
MarkdownFolder() - 类的构造器com.github.xiaoymin.knife4j.spring.model.MarkdownFolder
match(String) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.BasicFilter

O

OpenApiExtension - com.github.xiaoymin.knife4j.spring.extension中的类
OpenApiExtension(String) - 类的构造器com.github.xiaoymin.knife4j.spring.extension.OpenApiExtension
OpenApiExtensionResolver - com.github.xiaoymin.knife4j.spring.extension中的类
OpenApiExtensionResolver(OpenApiExtendSetting, List<MarkdownProperty>) - 类的构造器com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver
OpenApiMarkdownExtension - com.github.xiaoymin.knife4j.spring.extension中的类
OpenApiMarkdownExtension(List<OpenApiExtendMarkdownFile>) - 类的构造器com.github.xiaoymin.knife4j.spring.extension.OpenApiMarkdownExtension
OpenApiSettingExtension - com.github.xiaoymin.knife4j.spring.extension中的类
OpenApiSettingExtension(OpenApiExtendSetting) - 类的构造器com.github.xiaoymin.knife4j.spring.extension.OpenApiSettingExtension
OperationAuthorBuilderPlugin - com.github.xiaoymin.knife4j.spring.plugin中的类
OperationAuthorBuilderPlugin() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.OperationAuthorBuilderPlugin
OperationDynamicModelProvider - com.github.xiaoymin.knife4j.spring.plugin中的类
OperationDynamicModelProvider() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicModelProvider
OperationDynamicResponseModelProvider - com.github.xiaoymin.knife4j.spring.plugin中的类: 动态添加响应类
OperationDynamicResponseModelProvider() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicResponseModelProvider
OperationIgnoreParameterPlugin - com.github.xiaoymin.knife4j.spring.plugin中的类: 忽略接口某个参数,避免编写过多的实体类,该插件通过给Open API v2.0 的Path节点添加扩展属性x-ignoreParameters扩展属性,结合前端ui自定义实现过滤规则. 2.0.3版本添加includeParameters属性的支持
OperationIgnoreParameterPlugin() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.OperationIgnoreParameterPlugin
OperationOrderBuilderPlugin - com.github.xiaoymin.knife4j.spring.plugin中的类
OperationOrderBuilderPlugin() - 类的构造器com.github.xiaoymin.knife4j.spring.plugin.OperationOrderBuilderPlugin

P

ProductionSecurityFilter - com.github.xiaoymin.knife4j.spring.filter中的类
ProductionSecurityFilter(boolean) - 类的构造器com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter
ProductionSecurityFilter() - 类的构造器com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter

R

RestHandlerMapping - com.github.xiaoymin.knife4j.spring.model中的类
RestHandlerMapping(String, Class<?>, Method, Set<RequestMethod>) - 类的构造器com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
RestHandlerMapping() - 类的构造器com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping

S

SecurityBasicAuthFilter - com.github.xiaoymin.knife4j.spring.filter中的类
SecurityBasicAuthFilter(boolean, String, String) - 类的构造器com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
SecurityBasicAuthFilter(boolean) - 类的构造器com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
SecurityBasicAuthFilter() - 类的构造器com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
setAuthor(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiTag
setBasePath(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFiles
setBeanOfMethod(Method) - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
setBeanType(Class<?>) - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
setDirectory(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFolder
setEnableBasicAuth(boolean) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
setErrorMsg(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
setLocations(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFolder
setMarkdownFiles(List<MarkdownFile>) - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFiles
setMarkdownFiles(List<MarkdownFile>) - 类中的方法com.github.xiaoymin.knife4j.spring.model.MarkdownFolder
setMarkdownFiles(List<MarkdownFile>) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
setMethod(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
setOrder(Integer) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
setOrder(Integer) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiTag
setPassword(String) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
setPath(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
setPathSortLists(List<SwaggerBootstrapUiPath>) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
setProduction(boolean) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.ProductionSecurityFilter
setRequestMethods(Set<RequestMethod>) - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
setSwaggerBootstrapUi(SwaggerBootstrapUi) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerExt
setTagSortLists(List<SwaggerBootstrapUiTag>) - 类中的方法com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
setUrl(String) - 类中的方法com.github.xiaoymin.knife4j.spring.model.RestHandlerMapping
setUserName(String) - 类中的方法com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.ApiListingOrderReader
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.DynamicParameterBuilderPlugin
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.DynamicResponseModelReader
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationAuthorBuilderPlugin
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicModelProvider
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationDynamicResponseModelProvider
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationIgnoreParameterPlugin
supports(DocumentationType) - 类中的方法com.github.xiaoymin.knife4j.spring.plugin.OperationOrderBuilderPlugin
SwaggerBootstrapUi - com.github.xiaoymin.knife4j.spring.model中的类
SwaggerBootstrapUi() - 类的构造器com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi
swaggerBootstrapUi - 类中的变量com.github.xiaoymin.knife4j.spring.model.SwaggerExt
SwaggerBootstrapUiBasicAuthSession - 类中的静态变量com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter: basic auth验证
SwaggerBootstrapUiHostNameProvider - com.github.xiaoymin.knife4j.spring.common中的类
SwaggerBootstrapUiHostNameProvider() - 类的构造器com.github.xiaoymin.knife4j.spring.common.SwaggerBootstrapUiHostNameProvider
SwaggerBootstrapUiPath - com.github.xiaoymin.knife4j.spring.model中的类
SwaggerBootstrapUiPath(String, String, Integer) - 类的构造器com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
SwaggerBootstrapUiPath() - 类的构造器com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiPath
SwaggerBootstrapUiTag - com.github.xiaoymin.knife4j.spring.model中的类
SwaggerBootstrapUiTag() - 类的构造器com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiTag
SwaggerBootstrapUiTag(Integer) - 类的构造器com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUiTag
SwaggerBootstrapUiXForwardPrefixPathAdjuster - com.github.xiaoymin.knife4j.spring.common中的类
SwaggerBootstrapUiXForwardPrefixPathAdjuster(HttpServletRequest) - 类的构造器com.github.xiaoymin.knife4j.spring.common.SwaggerBootstrapUiXForwardPrefixPathAdjuster
SwaggerExt - com.github.xiaoymin.knife4j.spring.model中的类
SwaggerExt(Swagger) - 类的构造器com.github.xiaoymin.knife4j.spring.model.SwaggerExt

T

tagSortLists - 类中的变量com.github.xiaoymin.knife4j.spring.model.SwaggerBootstrapUi: tag排序属性

U

urlFilters - 类中的变量com.github.xiaoymin.knife4j.spring.filter.BasicFilter

A B C D E G I L M O P R S T U