| 程序包 | 说明 |
|---|---|
| springfox.documentation.builders | |
| springfox.documentation.schema | |
| springfox.documentation.service |
| 限定符和类型 | 方法和说明 |
|---|---|
ParameterBuilder |
ParameterBuilder.modelRef(ModelReference modelRef)
Represents the convenience method to infer the model reference
Consolidate or figure out whats can be rolled into the other.
|
ParameterBuilder |
ParameterBuilder.modelRef(ModelReference modelRef)
Represents the convenience method to infer the model reference
Consolidate or figure out whats can be rolled into the other.
|
OperationBuilder |
OperationBuilder.responseModel(ModelReference responseType)
Updates the reference to the response model
|
ResponseMessageBuilder |
ResponseMessageBuilder.responseModel(ModelReference responseModel)
Updates the model the response represents
|
ResponseMessageBuilder |
ResponseMessageBuilder.responseModel(ModelReference responseModel)
Updates the model the response represents
|
OperationBuilder |
OperationBuilder.responseModel(ModelReference responseType)
Updates the reference to the response model
|
| 限定符和类型 | 方法和说明 |
|---|---|
ResponseMessageBuilder |
ResponseMessageBuilder.headers(Map<String,ModelReference> headers)
|
ResponseMessageBuilder |
ResponseMessageBuilder.headers(Map<String,ModelReference> headers)
|
ModelBuilder |
ModelBuilder.subTypes(List<ModelReference> subTypes)
Updates the subclasses for this model.
|
ModelBuilder |
ModelBuilder.subTypes(List<ModelReference> subTypes)
Updates the subclasses for this model.
|
| 限定符和类型 | 类和说明 |
|---|---|
class |
ModelRef |
| 限定符和类型 | 方法和说明 |
|---|---|
ModelReference |
ModelProperty.getModelRef() |
ModelReference |
ModelProperty.getModelRef() |
| 限定符和类型 | 方法和说明 |
|---|---|
List<ModelReference> |
Model.getSubTypes() |
List<ModelReference> |
Model.getSubTypes() |
com.google.common.base.Optional<ModelReference> |
ModelRef.itemModel() |
com.google.common.base.Optional<ModelReference> |
ModelReference.itemModel() |
com.google.common.base.Optional<ModelReference> |
ModelReference.itemModel() |
com.google.common.base.Optional<ModelReference> |
ModelRef.itemModel() |
| 限定符和类型 | 方法和说明 |
|---|---|
ModelProperty |
ModelProperty.updateModelRef(com.google.common.base.Function<com.fasterxml.classmate.ResolvedType,? extends ModelReference> modelRefFactory) |
ModelProperty |
ModelProperty.updateModelRef(com.google.common.base.Function<com.fasterxml.classmate.ResolvedType,? extends ModelReference> modelRefFactory) |
| 构造器和说明 |
|---|
ModelRef(String type,
ModelReference itemType) |
ModelRef(String type,
ModelReference itemType) |
ModelRef(String type,
ModelReference itemType,
AllowableValues allowableValues) |
ModelRef(String type,
ModelReference itemType,
AllowableValues allowableValues) |
ModelRef(String type,
ModelReference itemModel,
AllowableValues allowableValues,
boolean isMap) |
ModelRef(String type,
ModelReference itemModel,
AllowableValues allowableValues,
boolean isMap) |
ModelRef(String type,
ModelReference itemType,
boolean isMap) |
ModelRef(String type,
ModelReference itemType,
boolean isMap) |
| 构造器和说明 |
|---|
Model(String id,
String name,
com.fasterxml.classmate.ResolvedType type,
String qualifiedType,
Map<String,ModelProperty> properties,
String description,
String baseModel,
String discriminator,
List<ModelReference> subTypes,
Object example,
Xml xml) |
Model(String id,
String name,
com.fasterxml.classmate.ResolvedType type,
String qualifiedType,
Map<String,ModelProperty> properties,
String description,
String baseModel,
String discriminator,
List<ModelReference> subTypes,
Object example,
Xml xml) |
| 限定符和类型 | 方法和说明 |
|---|---|
ModelReference |
Parameter.getModelRef() |
ModelReference |
Parameter.getModelRef() |
ModelReference |
Header.getModelReference() |
ModelReference |
Header.getModelReference() |
ModelReference |
Operation.getResponseModel() |
ModelReference |
ResponseMessage.getResponseModel() |
ModelReference |
ResponseMessage.getResponseModel() |
ModelReference |
Operation.getResponseModel() |
| 构造器和说明 |
|---|
Header(String name,
String description,
ModelReference modelReference) |
Header(String name,
String description,
ModelReference modelReference) |
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) |
Copyright © 2023. All rights reserved.