| 程序包 | 说明 |
|---|---|
| springfox.documentation.spi | |
| springfox.documentation.spi.schema.contexts | |
| springfox.documentation.spi.service | |
| springfox.documentation.spi.service.contexts |
| 限定符和类型 | 字段和说明 |
|---|---|
static DocumentationType |
DocumentationType.SPRING_WEB |
static DocumentationType |
DocumentationType.SPRING_WEB |
static DocumentationType |
DocumentationType.SWAGGER_12 |
static DocumentationType |
DocumentationType.SWAGGER_12 |
static DocumentationType |
DocumentationType.SWAGGER_2 |
static DocumentationType |
DocumentationType.SWAGGER_2 |
| 限定符和类型 | 方法和说明 |
|---|---|
DocumentationType |
ModelContext.getDocumentationType() |
DocumentationType |
ModelPropertyContext.getDocumentationType()
Documentation type this context supports, swagger 1.2, 2.0 or vanilla spring mvc
|
DocumentationType |
ModelPropertyContext.getDocumentationType()
Documentation type this context supports, swagger 1.2, 2.0 or vanilla spring mvc
|
DocumentationType |
ModelContext.getDocumentationType() |
| 限定符和类型 | 方法和说明 |
|---|---|
static ModelContext |
ModelContext.inputParam(String group,
Type type,
DocumentationType documentationType,
AlternateTypeProvider alternateTypeProvider,
GenericTypeNamingStrategy genericNamingStrategy,
com.google.common.collect.ImmutableSet<Class> ignorableTypes)
Convenience method to provide an new context for an input parameter
|
static ModelContext |
ModelContext.inputParam(String group,
Type type,
DocumentationType documentationType,
AlternateTypeProvider alternateTypeProvider,
GenericTypeNamingStrategy genericNamingStrategy,
com.google.common.collect.ImmutableSet<Class> ignorableTypes)
Convenience method to provide an new context for an input parameter
|
static ModelContext |
ModelContext.returnValue(String groupName,
Type type,
DocumentationType documentationType,
AlternateTypeProvider alternateTypeProvider,
GenericTypeNamingStrategy genericNamingStrategy,
com.google.common.collect.ImmutableSet<Class> ignorableTypes)
Convenience method to provide an new context for an return parameter
|
static ModelContext |
ModelContext.returnValue(String groupName,
Type type,
DocumentationType documentationType,
AlternateTypeProvider alternateTypeProvider,
GenericTypeNamingStrategy genericNamingStrategy,
com.google.common.collect.ImmutableSet<Class> ignorableTypes)
Convenience method to provide an new context for an return parameter
|
| 构造器和说明 |
|---|
ModelPropertyContext(ModelPropertyBuilder builder,
AnnotatedElement annotatedElement,
com.fasterxml.classmate.TypeResolver resolver,
DocumentationType documentationType) |
ModelPropertyContext(ModelPropertyBuilder builder,
AnnotatedElement annotatedElement,
com.fasterxml.classmate.TypeResolver resolver,
DocumentationType documentationType) |
ModelPropertyContext(ModelPropertyBuilder builder,
com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition beanPropertyDefinition,
com.fasterxml.classmate.TypeResolver resolver,
DocumentationType documentationType) |
ModelPropertyContext(ModelPropertyBuilder builder,
com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition beanPropertyDefinition,
com.fasterxml.classmate.TypeResolver resolver,
DocumentationType documentationType) |
| 限定符和类型 | 方法和说明 |
|---|---|
DocumentationType |
DocumentationPlugin.getDocumentationType() |
DocumentationType |
DocumentationPlugin.getDocumentationType() |
| 限定符和类型 | 方法和说明 |
|---|---|
DocumentationContextBuilder |
DefaultsProviderPlugin.create(DocumentationType documentationType)
Implement this method to override the @see springfox.documentation.spi.service.contexts
.DocumentationContextBuilder
|
DocumentationContextBuilder |
DefaultsProviderPlugin.create(DocumentationType documentationType)
Implement this method to override the @see springfox.documentation.spi.service.contexts
.DocumentationContextBuilder
|
| 限定符和类型 | 方法和说明 |
|---|---|
DocumentationType |
ApiListingContext.getDocumentationType() |
DocumentationType |
DocumentationContext.getDocumentationType() |
DocumentationType |
OperationContext.getDocumentationType() |
DocumentationType |
ParameterContext.getDocumentationType() |
DocumentationType |
ParameterExpansionContext.getDocumentationType() |
DocumentationType |
ParameterExpansionContext.getDocumentationType() |
DocumentationType |
ParameterContext.getDocumentationType() |
DocumentationType |
OperationContext.getDocumentationType() |
DocumentationType |
DocumentationContext.getDocumentationType() |
DocumentationType |
ApiListingContext.getDocumentationType() |
| 构造器和说明 |
|---|
ApiListingContext(DocumentationType documentationType,
ResourceGroup resourceGroup,
ApiListingBuilder apiListingBuilder) |
ApiListingContext(DocumentationType documentationType,
ResourceGroup resourceGroup,
ApiListingBuilder apiListingBuilder) |
DocumentationContext(DocumentationType documentationType,
List<RequestHandler> handlerMappings,
ApiInfo apiInfo,
String groupName,
ApiSelector apiSelector,
Set<Class> ignorableParameterTypes,
Map<org.springframework.web.bind.annotation.RequestMethod,List<ResponseMessage>> globalResponseMessages,
List<Parameter> globalOperationParameter,
ResourceGroupingStrategy resourceGroupingStrategy,
PathProvider pathProvider,
List<SecurityContext> securityContexts,
List<? extends SecurityScheme> securitySchemes,
List<AlternateTypeRule> alternateTypeRules,
com.google.common.collect.Ordering<ApiListingReference> listingReferenceOrdering,
com.google.common.collect.Ordering<ApiDescription> apiDescriptionOrdering,
com.google.common.collect.Ordering<Operation> operationOrdering,
Set<String> produces,
Set<String> consumes,
String host,
Set<String> protocols,
GenericTypeNamingStrategy genericsNamingStrategy,
com.google.common.base.Optional<String> pathMapping,
boolean isUriTemplatesEnabled,
Set<com.fasterxml.classmate.ResolvedType> additionalModels,
Set<Tag> tags,
List<VendorExtension> vendorExtensions) |
DocumentationContext(DocumentationType documentationType,
List<RequestHandler> handlerMappings,
ApiInfo apiInfo,
String groupName,
ApiSelector apiSelector,
Set<Class> ignorableParameterTypes,
Map<org.springframework.web.bind.annotation.RequestMethod,List<ResponseMessage>> globalResponseMessages,
List<Parameter> globalOperationParameter,
ResourceGroupingStrategy resourceGroupingStrategy,
PathProvider pathProvider,
List<SecurityContext> securityContexts,
List<? extends SecurityScheme> securitySchemes,
List<AlternateTypeRule> alternateTypeRules,
com.google.common.collect.Ordering<ApiListingReference> listingReferenceOrdering,
com.google.common.collect.Ordering<ApiDescription> apiDescriptionOrdering,
com.google.common.collect.Ordering<Operation> operationOrdering,
Set<String> produces,
Set<String> consumes,
String host,
Set<String> protocols,
GenericTypeNamingStrategy genericsNamingStrategy,
com.google.common.base.Optional<String> pathMapping,
boolean isUriTemplatesEnabled,
Set<com.fasterxml.classmate.ResolvedType> additionalModels,
Set<Tag> tags,
List<VendorExtension> vendorExtensions) |
DocumentationContextBuilder(DocumentationType documentationType) |
DocumentationContextBuilder(DocumentationType documentationType) |
OperationModelContextsBuilder(String group,
DocumentationType documentationType,
AlternateTypeProvider alternateTypeProvider,
GenericTypeNamingStrategy genericsNamingStrategy,
com.google.common.collect.ImmutableSet<Class> ignorableParameterTypes) |
OperationModelContextsBuilder(String group,
DocumentationType documentationType,
AlternateTypeProvider alternateTypeProvider,
GenericTypeNamingStrategy genericsNamingStrategy,
com.google.common.collect.ImmutableSet<Class> ignorableParameterTypes) |
ParameterExpansionContext(String dataTypeName,
String parentName,
String parameterType,
ParameterMetadataAccessor metadataAccessor,
DocumentationType documentationType,
ParameterBuilder parameterBuilder) |
ParameterExpansionContext(String dataTypeName,
String parentName,
String parameterType,
ParameterMetadataAccessor metadataAccessor,
DocumentationType documentationType,
ParameterBuilder parameterBuilder) |
Copyright © 2023. All rights reserved.