-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Read the data type in order of precedence
1. dataTypeClass 2. dataType using forName 3. explicit type and format (3388)
- Loading branch information
1 parent
e7e98e9
commit 3cd0f7c
Showing
5 changed files
with
174 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
...ngfox/documentation/swagger/readers/operation/OperationImplicitParameterReaderSpec.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package springfox.documentation.swagger.readers.operation | ||
|
|
||
| import spock.lang.Specification | ||
| import spock.lang.Unroll | ||
| import springfox.documentation.builders.ModelSpecificationBuilder | ||
| import springfox.documentation.builders.ReferenceModelSpecificationBuilder | ||
| import springfox.documentation.schema.Example | ||
| import springfox.documentation.schema.ScalarType | ||
| import springfox.documentation.swagger.readers.parameter.ApiImplicitParamAnnotationSupport | ||
|
|
||
| class OperationImplicitParameterReaderSpec extends Specification implements ApiImplicitParamAnnotationSupport { | ||
| @Unroll | ||
| def "Implicit params are evaluated correctly"() { | ||
| when: | ||
| def model = OperationImplicitParameterReader.modelSpecification(implicitParamAnnotation) | ||
|
|
||
| then: | ||
| model?.scalar?.orElse(null)?.type == expectedScalar | ||
| model?.reference?.orElse(null) == expectedReference | ||
| model?.collection | ||
| ?.map { c -> c.model } | ||
| ?.orElse(null) == collectionItemSpecification(expectedCollectionType) | ||
|
|
||
| where: | ||
| implicitParamAnnotation | expectedScalar | expectedCollectionType | expectedReference | ||
| apiImplicitParam() | null | null | null | ||
| apiImplicitParam("string") | ScalarType.STRING | null | null | ||
| apiImplicitParam("string", "byte") | ScalarType.BYTE | null | null | ||
| apiImplicitParam("string", "byte", "int") | ScalarType.INTEGER | null | null | ||
| apiImplicitParam("string", "byte", "int", Long) | ScalarType.LONG | null | null | ||
| apiImplicitParam("string", "byte", "int", Example) | null | null | reference(Example) | ||
| collectionApiImplicitParam() | null | null | null | ||
| collectionApiImplicitParam("string") | null | ScalarType.STRING | null | ||
| collectionApiImplicitParam("string", "byte") | null | ScalarType.BYTE | null | ||
| collectionApiImplicitParam("string", "byte", "int") | null | ScalarType.INTEGER | null | ||
| collectionApiImplicitParam("string", "byte", "int", Long) | null | ScalarType.LONG | null | ||
| collectionApiImplicitParam("string", "byte", "int", Example) | null | reference(Example) | null | ||
|
|
||
| } | ||
|
|
||
| def reference(Class clazz) { | ||
| new ReferenceModelSpecificationBuilder() | ||
| .key { k -> | ||
| k.qualifiedModelName { | ||
| q -> | ||
| q.name(clazz.simpleName) | ||
| .namespace(clazz.packageName) | ||
| } | ||
| }.build() | ||
| } | ||
|
|
||
| def collectionItemSpecification(type) { | ||
| if (type == null) { | ||
| return null | ||
| } | ||
| if (type instanceof ScalarType) { | ||
| return new ModelSpecificationBuilder() | ||
| .scalarModel(type) | ||
| .build() | ||
| } | ||
| return new ModelSpecificationBuilder() | ||
| .referenceModel { | ||
| r -> | ||
| r.copyOf(type) | ||
| }.build() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
...pringfox/documentation/swagger/readers/parameter/ApiImplicitParamAnnotationSupport.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| package springfox.documentation.swagger.readers.parameter | ||
|
|
||
| import io.swagger.annotations.ApiImplicitParam | ||
|
|
||
| trait ApiImplicitParamAnnotationSupport { | ||
| ApiImplicitParam apiParamWithType(type, format) { | ||
| apiImplicitParam(type, format) | ||
| } | ||
|
|
||
| ApiImplicitParam apiParamWithDataType(dataType) { | ||
| apiImplicitParam("", "", dataType) | ||
| } | ||
|
|
||
| ApiImplicitParam apiParamWithDataTypeClass(dataTypeClass) { | ||
| apiImplicitParam("", "", "", dataTypeClass) | ||
| } | ||
|
|
||
| ApiImplicitParam collectionApiImplicitParam( | ||
| type = "", | ||
| format = "", | ||
| dataType = "", | ||
| dataTypeClass = Void.class) { | ||
| [name : { -> "test" }, | ||
| type : { -> type }, | ||
| format : { -> format }, | ||
| dataType : { -> dataType }, | ||
| dataTypeClass: { -> dataTypeClass }, | ||
| allowMultiple: { -> true } | ||
| ] as ApiImplicitParam | ||
| } | ||
|
|
||
| ApiImplicitParam apiImplicitParam( | ||
| type = "", | ||
| format = "", | ||
| dataType = "", | ||
| dataTypeClass = Void.class) { | ||
| [name : { -> "test" }, | ||
| type : { -> type }, | ||
| format : { -> format }, | ||
| dataType : { -> dataType }, | ||
| dataTypeClass: { -> dataTypeClass }, | ||
| allowMultiple: { -> false } | ||
| ] as ApiImplicitParam | ||
| } | ||
|
|
||
| } |
3cd0f7cThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When will be 3.0.1 release to include this fix?
Thanks