Live API Documentation (Swagger UI)¶
This page provides a link to the live, interactive API documentation generated by Swagger.
Note: To access the Swagger UI, the Spring Boot application must be running.
Accessing Swagger UI¶
-
Run the application:
-
Open the Swagger UI: Once the application is running, you can access the Swagger UI at the following URL:
This will open an interactive web page where you can explore all the API endpoints, view their details, and even send test requests directly from your browser.
Static spec for review (no running app)¶
The spec is committed so it can be reviewed without starting the application:
- Browse the spec in Swagger UI (loads Swagger UI from a CDN; serve the built site over HTTP)
- openapi.json
Implementation: rest-api module (OpenApiConfig, springdoc annotations on ApiController).
Keeping the spec and the Postman collection current¶
OpenApiPostmanSyncTest fails when:
- a request in
Spring-Security-Reference-APIs-Enhanced.postman_collection.jsonis missing from the generated spec (actuator and/oauth2/authorization/*are exempt because they are not Spring MVC controllers); - an
ApiControlleroperation is missing from the Postman collection; docs/api/openapi.jsondiffers from the generated spec.
Regenerate the committed spec after changing endpoints: