PreSerialize filter for filtering of swagger JSON per operation tags by query params #92
Conversation
Useful for querying operations by tags
|
Hi Dusan Thanks for the PR. Could you also update the Readme with instructions on how to install it and how to use it (and what it does - I have no idea about tags in Swagger - how do you add a tag to a swagger doc? Is it via Swashbuckle?) This would be the first filter in the package which wasn't written by me. |
|
Yes. You can add tag by using Swashbuckle Annotations with SwaggerOperation attribute. Tags are defined in OpenAPI specifications Swagger UI uses tags to group operations. Swashbuckle by default uses controller name as tag for all actions in that controller. This filter allows retrieving only swagger operations included in query parameter search param. I will add documentation and How To use section :) |
|
|
||
| private static string[] GetQueryParamsByKey(HttpRequest req, string key, char separator) | ||
| { | ||
| return req.Query[key].ToString().Split(separator); |
There was a problem hiding this comment.
This always assumes that queryparams are provided in the syntax of key=value1,value2 however, it is also legitimate to provide a query string syntax of key=value1&key=value2.
Should the syntax you are proposing for the query string be required?
- In the case that the currently coded, you need to split the values, resulting in an array of strings.
- In the alternate case, the
req.Query[key]returns the same expected outcome. Resulting in an array of strings.
|
Closing this as it is 3 years old. |
PreSerialize filter to be filtering swagger document per operation tags
If you ever build large microservices and have multiple swaggers distributed throughout services, you may want to filter multiple swagger documents by tags.
For example both if several services serve single business domain, and concrete requirements are to aggregate swagger documents from mutiple services and show them to end user grouped as a single swagger, this filter becomes very usable.
I used this in 4 projects already. I send /swagger.json?tags=param1%2Cparam2 etc. and Swashbuckle returns me only those that have these respective tags.
Then I used a single aggregator service to create new swagger json (not connected to Swashbuckle or any other swagger generating library or service).