org.daijie.core.swagger

类 RewriteDocket

java.lang.Object

org.daijie.core.swagger.RewriteDocket

所有已实现的接口:

org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>, springfox.documentation.spi.service.DocumentationPlugin

直接已知子类:

PackRewirteDocket

public class RewriteDocket
extends Object
implements springfox.documentation.spi.service.DocumentationPlugin

重写Docket，主要是解决官方对这个类中的属性和方法的访问权限限制

从以下版本开始:

2018年1月2日

作者:

daijie_jay

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_GROUP_NAME

构造器概要

构造器

构造器和说明
RewriteDocket(springfox.documentation.spi.DocumentationType documentationType)

方法概要

限定符和类型	方法和说明
RewriteDocket	additionalModels(com.fasterxml.classmate.ResolvedType first, com.fasterxml.classmate.ResolvedType... remaining)
RewriteDocket	alternateTypeRules(springfox.documentation.schema.AlternateTypeRule... alternateTypeRules)
RewriteDocket	apiDescriptionOrdering(com.google.common.collect.Ordering<springfox.documentation.service.ApiDescription> apiDescriptionOrdering)
RewriteDocket	apiInfo(springfox.documentation.service.ApiInfo apiInfo)
RewriteDocket	apiListingReferenceOrdering(com.google.common.collect.Ordering<springfox.documentation.service.ApiListingReference> apiListingReferenceOrdering)
springfox.documentation.spi.service.contexts.DocumentationContext	configure(springfox.documentation.spi.service.contexts.DocumentationContextBuilder builder)
RewriteDocket	consumes(Set<String> consumes)
RewriteDocket	directModelSubstitute(Class clazz, Class with)
RewriteDocket	enable(boolean externallyConfiguredFlag)
RewriteDocket	enableUrlTemplating(boolean enabled)
RewriteDocket	extensions(List<springfox.documentation.service.VendorExtension> vendorExtensions)
RewriteDocket	forCodeGeneration(boolean forCodeGen)
RewriteDocket	genericModelSubstitutes(Class... genericClasses)
springfox.documentation.spi.DocumentationType	getDocumentationType()
String	getGroupName()
RewriteDocket	globalOperationParameters(List<springfox.documentation.service.Parameter> operationParameters)
RewriteDocket	globalResponseMessage(org.springframework.web.bind.annotation.RequestMethod requestMethod, List<springfox.documentation.service.ResponseMessage> responseMessages)
RewriteDocket	groupName(String groupName)
RewriteDocket	host(String host)
RewriteDocket	ignoredParameterTypes(Class... classes)
boolean	isEnabled()
RewriteDocket	operationOrdering(com.google.common.collect.Ordering<springfox.documentation.service.Operation> operationOrdering)
RewriteDocket	pathMapping(String path)
RewriteDocket	pathProvider(springfox.documentation.PathProvider pathProvider)
RewriteDocket	produces(Set<String> produces)
RewriteDocket	protocols(Set<String> protocols)
RewriteDocket	securityContexts(List<springfox.documentation.spi.service.contexts.SecurityContext> securityContexts)
RewriteDocket	securitySchemes(List<? extends springfox.documentation.service.SecurityScheme> securitySchemes)
RewriteApiSelectorBuilder	select()
boolean	supports(springfox.documentation.spi.DocumentationType delimiter)
RewriteDocket	tags(springfox.documentation.service.Tag first, springfox.documentation.service.Tag... remaining)
RewriteDocket	useDefaultResponseMessages(boolean apply)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_GROUP_NAME

public static final String DEFAULT_GROUP_NAME

另请参阅:

常量字段值

构造器详细资料

RewriteDocket

public RewriteDocket(springfox.documentation.spi.DocumentationType documentationType)

方法详细资料

extensions

public RewriteDocket extensions(List<springfox.documentation.service.VendorExtension> vendorExtensions)

apiInfo

public RewriteDocket apiInfo(springfox.documentation.service.ApiInfo apiInfo)

securitySchemes

public RewriteDocket securitySchemes(List<? extends springfox.documentation.service.SecurityScheme> securitySchemes)

securityContexts

public RewriteDocket securityContexts(List<springfox.documentation.spi.service.contexts.SecurityContext> securityContexts)

groupName

public RewriteDocket groupName(String groupName)

pathProvider

public RewriteDocket pathProvider(springfox.documentation.PathProvider pathProvider)

globalResponseMessage

public RewriteDocket globalResponseMessage(org.springframework.web.bind.annotation.RequestMethod requestMethod,
                                           List<springfox.documentation.service.ResponseMessage> responseMessages)

globalOperationParameters

public RewriteDocket globalOperationParameters(List<springfox.documentation.service.Parameter> operationParameters)

ignoredParameterTypes

public RewriteDocket ignoredParameterTypes(Class... classes)

produces

public RewriteDocket produces(Set<String> produces)

consumes

public RewriteDocket consumes(Set<String> consumes)

host

public RewriteDocket host(String host)

protocols

public RewriteDocket protocols(Set<String> protocols)

alternateTypeRules

public RewriteDocket alternateTypeRules(springfox.documentation.schema.AlternateTypeRule... alternateTypeRules)

operationOrdering

public RewriteDocket operationOrdering(com.google.common.collect.Ordering<springfox.documentation.service.Operation> operationOrdering)

directModelSubstitute

public RewriteDocket directModelSubstitute(Class clazz,
                                           Class with)

genericModelSubstitutes

public RewriteDocket genericModelSubstitutes(Class... genericClasses)

useDefaultResponseMessages

public RewriteDocket useDefaultResponseMessages(boolean apply)

apiListingReferenceOrdering

public RewriteDocket apiListingReferenceOrdering(com.google.common.collect.Ordering<springfox.documentation.service.ApiListingReference> apiListingReferenceOrdering)

apiDescriptionOrdering

public RewriteDocket apiDescriptionOrdering(com.google.common.collect.Ordering<springfox.documentation.service.ApiDescription> apiDescriptionOrdering)

enable

public RewriteDocket enable(boolean externallyConfiguredFlag)

forCodeGeneration

public RewriteDocket forCodeGeneration(boolean forCodeGen)

pathMapping

public RewriteDocket pathMapping(String path)

enableUrlTemplating

public RewriteDocket enableUrlTemplating(boolean enabled)

additionalModels

public RewriteDocket additionalModels(com.fasterxml.classmate.ResolvedType first,
                                      com.fasterxml.classmate.ResolvedType... remaining)

tags

public RewriteDocket tags(springfox.documentation.service.Tag first,
                          springfox.documentation.service.Tag... remaining)

select

public RewriteApiSelectorBuilder select()

configure

public springfox.documentation.spi.service.contexts.DocumentationContext configure(springfox.documentation.spi.service.contexts.DocumentationContextBuilder builder)

指定者:

configure 在接口中 springfox.documentation.spi.service.DocumentationPlugin

getGroupName

public String getGroupName()

指定者:

getGroupName 在接口中 springfox.documentation.spi.service.DocumentationPlugin

isEnabled

public boolean isEnabled()

指定者:

isEnabled 在接口中 springfox.documentation.spi.service.DocumentationPlugin

getDocumentationType

public springfox.documentation.spi.DocumentationType getDocumentationType()

指定者:

getDocumentationType 在接口中 springfox.documentation.spi.service.DocumentationPlugin

supports

public boolean supports(springfox.documentation.spi.DocumentationType delimiter)

指定者:

supports 在接口中 org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>