An API responsible for handling car related operations.

• Introduction
• Features
• Requirements
• Quick Start
• Testing
• API
• Acknowledgements

This API was developed with Spring Boot and PostgreSQL as a studying project.

TODO: Description of features

• Include a list of
• all the many beautiful
• web server features

It is recommended to run the application in a docker container, the requirements for each setup are listed below.

• Docker

Make sure the JWT Verification Key URL is configured, then you can run the server in a docker container or on your local machine.

Update application.yml. Set auth.jwt.publicKeyUrl to the URL to fetch the JWT verification key. The application will not start if it can't set the verification key for the JWTConverter.

The default value in the application.yml file is set to connect to EGO running locally on its default port 8081.

$ mvn spring-boot:run

Application will run by default on port 1234

Configure the port by changing server.port in application.yml

First build the image:

$ docker-compose build

When ready, run it:

$ docker-compose up

Application will run by default on port 8080

Configure the port by changing services.api.ports in docker-compose.yml.

TODO: API Reference with examples, or a link to a wiki or other documentation source.