Hi everyone,
While working with our APIs, I’ve noticed that understanding what endpoints exist, what payloads they expect, and how they evolve often requires digging through controller code,relying on shared knowledge or continous inspection of devtool calls. This works, but it can be time consuming, especially for new contributors or frontend work.
I’m curious about the community’s thoughts on introducing OpenAPI (Swagger) purely as a documentation and discoverability layer not to change existing controllers or behavior, but to make the current REST APIs easier to explore and reason about.
The idea would be:
- Document existing Spring MVC endpoints as they are
- Generate an OpenAPI spec from annotations or configuration
- Optionally expose Swagger UI in dev/test environments only
I’d love to hear the community’s thoughts on this:
- Would a read-only Swagger layer help in your workflow?
- Are there concerns with exposing it, even in dev/test environments?
- Any suggestions for making adoption smooth without touching the existing API behavior?