This repository holds the OpenAPI documentation for the TIS Trainee API.
The latest documentation is always available at health-education-england.github.io/tis-trainee-api.
The API documentation can be worked on within any text editor or IDE. Plugins are available for several popular IDEs.
Several options are provided for previewing the documentation
A Docker compose file is provided for ease of use, the
openapi.yml file will be mapped in to the container so edits can
be viewed without restarting the container. Run docker compose up -d followed
by navigating to http://localhost:8080.
Node can be used to bundle and serve an OpenAPI viewer by running npm run start,
the viewer will open automatically.
This project uses Semantic Versioning.
This project is license under The MIT License (MIT).