类的使用
springfox.documentation.spring.web.plugins.Docket

使用Docket的程序包

程序包	说明
springfox.documentation.spring.web.plugins

springfox.documentation.spring.web.plugins中Docket的使用

返回Docket的springfox.documentation.spring.web.plugins中的方法

修饰符和类型	方法	说明
Docket	Docket.additionalModels(com.fasterxml.classmate.ResolvedType first, com.fasterxml.classmate.ResolvedType... remaining)	Method to add additional models that are not part of any annotation or are perhaps implicit
Docket	Docket.alternateTypeRules(AlternateTypeRule... alternateTypeRules)	Adds model substitution rules (alternateTypeRules)
Docket	Docket.apiDescriptionOrdering(com.google.common.collect.Ordering<ApiDescription> apiDescriptionOrdering)	Controls how io.swagger.model.ApiDescription's are ordered.
Docket	Docket.apiInfo(ApiInfo apiInfo)	Sets the api's meta information as included in the json ResourceListing response.
Docket	Docket.apiListingReferenceOrdering(com.google.common.collect.Ordering<ApiListingReference> apiListingReferenceOrdering)	Controls how ApiListingReference's are sorted.
Docket	ApiSelectorBuilder.build()
Docket	Docket.consumes(Set<String> consumes)
Docket	Docket.directModelSubstitute(Class clazz, Class with)	Directly substitutes a model class with the supplied substitute e.g directModelSubstitute(LocalDate.class, Date.class) would substitute LocalDate with Date
Docket	Docket.enable(boolean externallyConfiguredFlag)	Hook to externally control auto initialization of this swagger plugin instance.
Docket	Docket.enableUrlTemplating(boolean enabled)	Decides whether to use url templating for paths.
Docket	Docket.extensions(List<VendorExtension> vendorExtensions)	Add to the api's vendor extensions
Docket	Docket.forCodeGeneration(boolean forCodeGen)	Set this to true in order to make the documentation code generation friendly
Docket	Docket.genericModelSubstitutes(Class... genericClasses)	Substitutes each generic class with it's direct parameterized type.
Docket	Docket.globalOperationParameters(List<Parameter> operationParameters)	Adds default parameters which will be applied to all operations.
Docket	Docket.globalResponseMessage(org.springframework.web.bind.annotation.RequestMethod requestMethod, List<ResponseMessage> responseMessages)	Overrides the default http response messages at the http request method level.
Docket	Docket.groupName(String groupName)	If more than one instance of Docket exists, each one must have a unique groupName as supplied by this method.
Docket	Docket.host(String host)
Docket	Docket.ignoredParameterTypes(Class... classes)	Adds ignored controller method parameter types so that the framework does not generate swagger model or parameter information for these specific types.
Docket	Docket.operationOrdering(com.google.common.collect.Ordering<Operation> operationOrdering)	Provide an ordering schema for operations NOTE: @see #732 in case you're wondering why specifying position might not work.
Docket	Docket.pathMapping(String path)	Extensibility mechanism to add a servlet path mapping, if there is one, to the apis base path.
Docket	Docket.pathProvider(springfox.documentation.PathProvider pathProvider)	Determines the generated, swagger specific, urls.
Docket	Docket.produces(Set<String> produces)
Docket	Docket.protocols(Set<String> protocols)
Docket	Docket.securityContexts(List<SecurityContext> securityContexts)	Configures which api operations (via regex patterns) and HTTP methods to apply security contexts to apis.
Docket	Docket.securitySchemes(List<? extends SecurityScheme> securitySchemes)	Configures the global io.swagger.model.SecurityScheme's applicable to all or some of the api operations.
Docket	Docket.tags(Tag first, Tag... remaining)	Method to add global tags to the docket
Docket	Docket.useDefaultResponseMessages(boolean apply)	Allows ignoring predefined response message defaults

参数类型为Docket的springfox.documentation.spring.web.plugins中的构造器

限定符	构造器	说明
	ApiSelectorBuilder(Docket parent)