The entire API is documented according to the OpenAPI specification. The spec is auto-generated from the source code and is available on the following URLs:
- OpenAPI Spec (JSON): http://localhost:8080/openapi
- OpenAPI Spec (YAML): http://localhost:8080/openapi.yaml
- This can be used to generate client SDKs e.g.: Rapini (React Query SDK generator)
- Swagger UI (interactive API docs): http://localhost:8080/swagger-ui.html
There is a docker-compose.yml file in the root of the project that can be used to start a MySQL database
for development purposes.
- Install Docker and Docker Compose
- Run
docker-compose up -dto start the database - Run the backend application with the
spring.jpa.hibernate.ddl-autoapplication property (./Projector-server/src/main/resources/application.properties) set tocreate
- NOTE: please do not commit this change, as it may bring some unintended consequences on the production database!
- Kill the application (if it's not already killed by an error)
- Reset the
spring.jpa.hibernate.ddl-autoproperty tonone - Run the application again normally
These steps are necessary because the database is not initialized with the necessary tables when the application is started for the first time.