CODEWITHSUNDEEP
restswaggerapi-doc
Subash Chaturanga
Subash Chaturanga

Reputation: 834

Cannot use REST comments in Swagger

I have downloaded swagger ui and experimenting it locally. It works fine in scenarios like "path", "body" , and "query" . But most of my use cases use rest comments.

i.e /resourcePath/;tags URI to retrieve the tags of a specific resource.

When I try this the the UI gets jumbled when adding the semi colon and malformed the sorted UI and cannot go beyond this.

So is this a known limitation ? Is there a workaround to accomplish this target ? Appreciate any input to this..

Upvotes: 0

Views: 469

Answers (1)

fehguy
fehguy

Reputation: 6824

Swagger is expecting you to specify path params in curly-brackets like {tags} and query params as comma-delimited, such as id=1,2,3,4. Some frameworks use semi-colons as delimiters but swagger likes commas.

Can you describe more what you're looking to do, with a more concrete example? Per design, comments on the api belong in the description and notes fields for operations, please see swagger-core wiki for details.

The Swagger codegen project has a validator which can be used to verify that your spec is properly formatted.

Upvotes: 1

Related Questions