| 程序包 | 说明 |
|---|---|
| springfox.documentation.builders | |
| springfox.documentation.schema | |
| springfox.documentation.service |
| 限定符和类型 | 方法和说明 |
|---|---|
ApiInfoBuilder |
ApiInfoBuilder.extensions(List<VendorExtension> extensions)
Adds extensions for this API
|
DocumentationBuilder |
DocumentationBuilder.extensions(List<VendorExtension> extensions)
Adds extensions for this API
|
ModelPropertyBuilder |
ModelPropertyBuilder.extensions(List<VendorExtension> extensions) |
OperationBuilder |
OperationBuilder.extensions(List<VendorExtension> extensions)
Updates the operation extensions
|
OperationBuilder |
OperationBuilder.extensions(List<VendorExtension> extensions)
Updates the operation extensions
|
ModelPropertyBuilder |
ModelPropertyBuilder.extensions(List<VendorExtension> extensions) |
DocumentationBuilder |
DocumentationBuilder.extensions(List<VendorExtension> extensions)
Adds extensions for this API
|
ApiInfoBuilder |
ApiInfoBuilder.extensions(List<VendorExtension> extensions)
Adds extensions for this API
|
ParameterBuilder |
ParameterBuilder.vendorExtensions(List<VendorExtension> extensions)
Updates the parameter extensions
|
ResponseMessageBuilder |
ResponseMessageBuilder.vendorExtensions(List<VendorExtension> extensions)
Updates the response message extensions
|
ResponseMessageBuilder |
ResponseMessageBuilder.vendorExtensions(List<VendorExtension> extensions)
Updates the response message extensions
|
ParameterBuilder |
ParameterBuilder.vendorExtensions(List<VendorExtension> extensions)
Updates the parameter extensions
|
| 限定符和类型 | 方法和说明 |
|---|---|
List<VendorExtension> |
ModelProperty.getVendorExtensions() |
List<VendorExtension> |
ModelProperty.getVendorExtensions() |
| 构造器和说明 |
|---|
ModelProperty(String name,
com.fasterxml.classmate.ResolvedType type,
String qualifiedType,
int position,
boolean required,
boolean isHidden,
boolean readOnly,
Boolean allowEmptyValue,
String description,
AllowableValues allowableValues,
Object example,
String pattern,
String defaultValue,
Xml xml,
List<VendorExtension> vendorExtensions) |
ModelProperty(String name,
com.fasterxml.classmate.ResolvedType type,
String qualifiedType,
int position,
boolean required,
boolean isHidden,
boolean readOnly,
Boolean allowEmptyValue,
String description,
AllowableValues allowableValues,
Object example,
String pattern,
String defaultValue,
Xml xml,
List<VendorExtension> vendorExtensions) |
| 限定符和类型 | 类和说明 |
|---|---|
class |
ListVendorExtension<T> |
class |
ObjectVendorExtension |
class |
StringVendorExtension |
| 限定符和类型 | 方法和说明 |
|---|---|
List<VendorExtension> |
ObjectVendorExtension.getValue() |
List<VendorExtension> |
ObjectVendorExtension.getValue() |
List<VendorExtension> |
ApiInfo.getVendorExtensions() |
List<VendorExtension> |
Documentation.getVendorExtensions() |
List<VendorExtension> |
Operation.getVendorExtensions() |
List<VendorExtension> |
ResponseMessage.getVendorExtensions() |
List<VendorExtension> |
SecurityScheme.getVendorExtensions() |
List<VendorExtension> |
Tag.getVendorExtensions() |
List<VendorExtension> |
Tag.getVendorExtensions() |
List<VendorExtension> |
SecurityScheme.getVendorExtensions() |
List<VendorExtension> |
ResponseMessage.getVendorExtensions() |
List<VendorExtension> |
Operation.getVendorExtensions() |
List<VendorExtension> |
Documentation.getVendorExtensions() |
List<VendorExtension> |
ApiInfo.getVendorExtensions() |
List<VendorExtension> |
Parameter.getVendorExtentions() |
List<VendorExtension> |
Parameter.getVendorExtentions() |
| 限定符和类型 | 方法和说明 |
|---|---|
void |
ObjectVendorExtension.addProperty(VendorExtension property) |
void |
ObjectVendorExtension.addProperty(VendorExtension property) |
void |
ObjectVendorExtension.replaceProperty(VendorExtension property) |
void |
ObjectVendorExtension.replaceProperty(VendorExtension property) |
| 限定符和类型 | 方法和说明 |
|---|---|
protected void |
SecurityScheme.addValidVendorExtensions(List<VendorExtension> vendorExtensions) |
protected void |
SecurityScheme.addValidVendorExtensions(List<VendorExtension> vendorExtensions) |
| 构造器和说明 |
|---|
ApiInfo(String title,
String description,
String version,
String termsOfServiceUrl,
Contact contact,
String license,
String licenseUrl,
Collection<VendorExtension> vendorExtensions)
Default contstructor
|
ApiInfo(String title,
String description,
String version,
String termsOfServiceUrl,
Contact contact,
String license,
String licenseUrl,
Collection<VendorExtension> vendorExtensions)
Default contstructor
|
ApiKey(String name,
String keyname,
String passAs,
List<VendorExtension> vendorExtensions) |
ApiKey(String name,
String keyname,
String passAs,
List<VendorExtension> vendorExtensions) |
BasicAuth(String name,
List<VendorExtension> vendorExtensions) |
BasicAuth(String name,
List<VendorExtension> vendorExtensions) |
Documentation(String groupName,
String basePath,
Set<Tag> tags,
com.google.common.collect.Multimap<String,ApiListing> apiListings,
ResourceListing resourceListing,
Set<String> produces,
Set<String> consumes,
String host,
Set<String> schemes,
Collection<VendorExtension> vendorExtensions) |
Documentation(String groupName,
String basePath,
Set<Tag> tags,
com.google.common.collect.Multimap<String,ApiListing> apiListings,
ResourceListing resourceListing,
Set<String> produces,
Set<String> consumes,
String host,
Set<String> schemes,
Collection<VendorExtension> vendorExtensions) |
OAuth(String name,
List<AuthorizationScope> scopes,
List<GrantType> grantTypes,
List<VendorExtension> vendorExtensions) |
OAuth(String name,
List<AuthorizationScope> scopes,
List<GrantType> grantTypes,
List<VendorExtension> vendorExtensions) |
Operation(org.springframework.http.HttpMethod method,
String summary,
String notes,
ModelReference responseModel,
String uniqueId,
int position,
Set<String> tags,
Set<String> produces,
Set<String> consumes,
Set<String> protocol,
List<SecurityReference> securityReferences,
List<Parameter> parameters,
Set<ResponseMessage> responseMessages,
String deprecated,
boolean isHidden,
Collection<VendorExtension> vendorExtensions) |
Operation(org.springframework.http.HttpMethod method,
String summary,
String notes,
ModelReference responseModel,
String uniqueId,
int position,
Set<String> tags,
Set<String> produces,
Set<String> consumes,
Set<String> protocol,
List<SecurityReference> securityReferences,
List<Parameter> parameters,
Set<ResponseMessage> responseMessages,
String deprecated,
boolean isHidden,
Collection<VendorExtension> vendorExtensions) |
Parameter(String name,
String description,
String defaultValue,
boolean required,
boolean allowMultiple,
Boolean allowEmptyValue,
ModelReference modelRef,
com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> type,
AllowableValues allowableValues,
String paramType,
String paramAccess,
boolean hidden,
String pattern,
String collectionFormat,
int order,
Object scalarExample,
com.google.common.collect.Multimap<String,Example> examples,
List<VendorExtension> vendorExtensions) |
Parameter(String name,
String description,
String defaultValue,
boolean required,
boolean allowMultiple,
Boolean allowEmptyValue,
ModelReference modelRef,
com.google.common.base.Optional<com.fasterxml.classmate.ResolvedType> type,
AllowableValues allowableValues,
String paramType,
String paramAccess,
boolean hidden,
String pattern,
String collectionFormat,
int order,
Object scalarExample,
com.google.common.collect.Multimap<String,Example> examples,
List<VendorExtension> vendorExtensions) |
ResponseMessage(int code,
String message,
ModelReference responseModel,
Map<String,Header> headers,
List<VendorExtension> vendorExtensions) |
ResponseMessage(int code,
String message,
ModelReference responseModel,
Map<String,Header> headers,
List<VendorExtension> vendorExtensions) |
Tag(String name,
String description,
int order,
List<VendorExtension> vendorExtensions) |
Tag(String name,
String description,
int order,
List<VendorExtension> vendorExtensions) |
Tag(String name,
String description,
List<VendorExtension> vendorExtensions) |
Tag(String name,
String description,
List<VendorExtension> vendorExtensions) |
Copyright © 2023. All rights reserved.