Organize api
module in a flat structure instead of using tags
#951
ferdinandvanwyk
started this conversation in
Feature request
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
How feasible is it to add a configuration parameter to toggle the organization of the
api
module such that they are just in a flat hierarchy instead of organized bytag
? Is there an existing configuration parameter I could use to achieve something similar?According to the Swagger docs the
tags
are used to group endpoints together. While this sounds great, as a client of a REST service I don't own and creating a library to call it, I am not in control of thesetags
. They could be:In each of the above cases, regenerating the code from the spec will lead to non-backwards compatible changes as the code will be moved to different modules. For example, an endpoint under
default
that gets a tag addedfoo
, will mean that any use of that module will no longer work.Day 1, there is no tag for an endpoint means I might have existing code like this:
Day 2, the service owners change the spec to add a tag
foo
. Now the above code no longer works and needs to be changed toThis can create technical debt due to a benign change from the service owner that should be free to re-organize endpoints under different
tags
as their service evolves.I'm new to trying to use this project and interested to hear thoughts on the above from other users and maintainers. 🙂
Beta Was this translation helpful? Give feedback.
All reactions