Skip to content

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

  1. Run the application:

    ./gradlew :rest-api:bootRun
    

  2. Open the Swagger UI: Once the application is running, you can access the Swagger UI at the following URL:

    http://localhost:8080/swagger-ui.html

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:

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.json is missing from the generated spec (actuator and /oauth2/authorization/* are exempt because they are not Spring MVC controllers);
  • an ApiController operation is missing from the Postman collection;
  • docs/api/openapi.json differs from the generated spec.

Regenerate the committed spec after changing endpoints:

./gradlew :rest-api:test --tests '*OpenApiPostmanSyncTest' -Popenapi.update=true