Bugs fixing and minor improvements #37
Merged
Conversation
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
added 2 commits
February 19, 2014 18:13
ApiOperationParser 1. A bug when we have @ApiOperation without "method" specified. Then value is taken from httpMethod (without trimming). As a result we get "POST ", which is not recognized by Swagger UI. 2. A bug when we have @ApiOperation without "produces" or "consumes" specifed. Then code populates this arrays with "" value and then in Swagger UI we see "Produces: ['']" 3. ApiError renamed to ApiResponse in code 4. Validation logic partially moved to DocumentationOperation (as well as toScalaOperation()) ApiModelParser, ApiParserImpl 5. A bug with missing models. Some of the models were ignored by parsing and Swagger UI had no ability to show them to user. Models parsing logic was moved to ApiUtils class so that both of classes mentioned could use it. In future, probably, it is better to merge this "model parsing logic" and remove baseModelPackage property, because it seems that this property is not necessary. 6. Work with Generics was improved. Code now correctly parses generic return types: List<SomeClass> -> List[SomeClass] ContainerClass<InnerClass> -> ContainerClass[InnerClass] My Fork of Swagger UI renders such response types correctly swagger-api/swagger-ui#401 Elements with only one generic would be processed.
…Type="form"). That caused crash in swagger-ui. baseModelPackage and additionaModelPackages were removed since there were unnecessary. All models are now adding on the go, that increased speed and amount of data sent to client (swagger ui).
|
These changes look good, dayman. Thanks! |
wkennedy
pushed a commit
that referenced
this pull request
Feb 25, 2014
Bugs fixing and minor improvements
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ApiOperationParser
Then value is taken from httpMethod (without trimming). As a result we get "POST ", which is not recognized by Swagger UI.
Then code populates this arrays with "" value and then in Swagger UI we see "Produces: ['']"
ApiModelParser, ApiParserImpl
5. A bug with missing models.
Some of the models were ignored by parsing and Swagger UI had no ability to show them to user.
Models parsing logic was moved to ApiUtils class so that both of classes mentioned could use it.
In future, probably, it is better to merge this "model parsing logic" and remove baseModelPackage property, because it seems that this property is not necessary.
6. Work with Generics was improved. Code now correctly parses generic return types:
List -> List[SomeClass]
ContainerClass -> ContainerClass[InnerClass]
My Fork of Swagger UI renders such response types correctly
swagger-api/swagger-ui#401
Elements with only one generic would be processed.