OpenAPI / Swagger / ReDoc#
Interactive API browser#
The UCS@school Kelvin REST API offers two web interfaces to explore the API graphically:
The Swagger UI at
The ReDoc UI at
The OpenAPI specification can be downloaded at:
The Swagger UI allows direct interaction (reading, creating users etc.) with the API server.
To use it, a token must first be retrieved by clicking the
Authorize button in the top right corner.
In the pop-up, the username must be of a user in the group
Administrator is added to this group by default.
After supplying the password and clicking the
Authorize button the pop-up can be closed.
Then methods of resources can be used.
After opening on one, a click on
Try it out on the right side will allow to
Execute the request.
Generating client code from OpenAPI schema#
Source code for UCS@school Kelvin REST API clients can be auto-generated by a number of tools.
Popular open source tools that can generate source code from the servers
openapi.json for over 50 programming languages are: