The Swagger UI provides a friendly interface for observing controllers, their endpoints, fields, parameters, bodies, and even sample requests.
The API Docs might be closer to what you are looking for with the above details organized into a JSON structure. It's likely you would be able to send them a link to your API Docs so long as the app is running somewhere.
You can take this many steps further and annotate specific fields of your request models with examples, annotate controller methods with possible responses, and so forth, all of which propagate to the API Docs and Swagger UI.
Hope this helps, and makes life at work a bit easier!
That's unfortunate! Our team also has restrictions on using Open API, but we're still able to use Swagger 2.0. Less automation but still does what we need.
Best of luck out there!
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
You may be able to consider OpenAPI a scalable alternative. See below for more details.
build.gradle
OR
pom.xml
Then you automagically gain access to the Swagger UI and the API Docs, which may be accessed (while the app is running) at server:port/swagger-ui.html and server:port/v3/api-docs.
The Swagger UI provides a friendly interface for observing controllers, their endpoints, fields, parameters, bodies, and even sample requests.
The API Docs might be closer to what you are looking for with the above details organized into a JSON structure. It's likely you would be able to send them a link to your API Docs so long as the app is running somewhere.
You can take this many steps further and annotate specific fields of your request models with examples, annotate controller methods with possible responses, and so forth, all of which propagate to the API Docs and Swagger UI.
Hope this helps, and makes life at work a bit easier!
A really good suggestion! Thanks.
Although we have some restrictions about implementing this, it would be a good alternative in other cases.
That's unfortunate! Our team also has restrictions on using Open API, but we're still able to use Swagger 2.0. Less automation but still does what we need.
Best of luck out there!