Server API Documentation
Access Documentation
You can find the documentation of the server API here (opens in an external tab / window).
Information about the Documentation
This documentation comes with a separate and auto-generated documentation for the server API. It uses compodoc to generate the documentation based on the modules, controllers, services, classes, ... present in the server. The generator creates corresponding diagrams and uses the JSDoc (if present).
Please note that compodoc only support a few JSDoc tags. You can find a complete list of supported tags in the compodoc documentation.
Generate Documentation
The documentation for the server API is automatically generated upon running the build command for this documentation.
pnpm build
However, you can just generate the documentation for the server by running the following command.
It will generate the documentation inside the ./static/server-doc/ folder inside the project for this documentation.
pnpm docs:server
To just inspect the generated server docs you can run the following command inside the docs/ project.
pnpx compodoc -s -d ./static/server-doc/
This will start a webserver which serves the documentation of the server.
You can access it via http://localhost:8080.
By default the compodoc webserver and the TMS server both use the port 8080.
You can change the port used by compodoc by adding the --port [port] parameter to the command above.