API Reference
The REST API is described in two places:
- OpenAPI (
endpoints.yaml) — the machine-readable spec is checked into the repository atdocumentation/static/files/endpoints.yaml. It is also served from this site at/files/endpoints.yaml. Import it into any OpenAPI viewer (Swagger UI, Redoc, VS Code REST Client, IntelliJ, …). - Postman collection — a ready-to-use collection lives at
documentation/static/files/Thesis Management API.postman_collection.json. It is also served from this site at/files/Thesis Management API.postman_collection.json. Import it into Postman for interactive exploration.
Local Swagger UI
When the server is running locally, an interactive Swagger UI is served at
http://localhost:8180/swagger-ui/index.html. It is generated from the same
Spring annotations that the checked-in spec is derived from, so it always
reflects the code you're running against.