Swagger: wildcard path parameters

by

This is not supported as of OpenAPI 3.1, and I have to resort to a workaround.

If I have a path /tags{tag_path} and I enter something like this as tag_path: /foo/bar, then the actual query request URL will be: /tags%2Ffoo%2Fbar. So, I just added support for that on my backend: the endpoint handler for /tags* urldecodes the path (which is %2Ffoo%2Fbar), and it becomes /foo/bar again.

Yes, a hack, but it works, and it’s better than nothing. In my case, tag names can’t contain the / character, so there’s no conflict. Your mileage may vary, of course.

More Related Contents:

  1. How to return an array of objects in SwaggerHub?
  2. How to define a mixed-type array (with different element types) in OpenAPI 2.0?
  3. Swagger schema properties ignored when using $ref – why?
  4. Swagger 2.0: Multiple Path objects with different paths but same request and response
  5. Swagger/OpenAPI – use $ref to pass a reusable defined parameter
  6. Schema object without a type attribute in Swagger 2.0
  7. Swagger: take one or more values from enum
  8. How to export swagger.json (or yaml)
  9. Swagger: How to have a property reference a model in OpenAPI 2.0 (i.e. nest the models)?
  10. How to specify if a field is optional or required in OpenAPI/Swagger?
  11. Swagger/OpenAPI mock server
  12. How to document dynamic query parameter names in OpenAPI (Swagger)?
  13. How can I represent ‘Authorization: Bearer ‘ in a Swagger Spec (swagger.json)
  14. How to define a property that can be string or null in OpenAPI (Swagger)?
  15. How to define mutually exclusive query parameters in Swagger (OpenAPI)?
  16. Use object type query param in swagger documentation
  17. How to convert OpenAPI 2.0 to OpenAPI 3.0? [closed]
  18. Swagger complex response model with dynamic key value hash maps
  19. How to define an optional parameter in path using swagger
  20. Swagger API which is having query string
  21. Swagger: “equivalent path already exists” despite different parameters
  22. How to configure Spring Security to allow Swagger URL to be accessed without authentication
  23. Re-using model with different required properties
  24. How to write OpenAPI 3 (Swagger) specification for property name in `map` object?
  25. How not to copy-paste 3 generic error responses in almost all paths?
  26. Combining defintions in Swagger docs
  27. How to define global parameters in OpenAPI?
  28. How to change Swagger-ui URL prefix?
  29. How to format Swagger 2.0 text descriptions?
  30. Sort API methods in Swagger-UI

Leave a Comment