e-cordel REST API

This is the REST API for e-cordel project.

In this project you can find an openapi specification with all the information about the endpoints available.

Dependencies

You need

• java 21 installed
• docker 20+ installed
• maven 3.8.5+ installed

💡 If you don't have the dependencies installed you can create a github codespace on your fork and run the commands below.

How to build locally

You can build with maven

mvn clean package

How to run in local develop

To up postgres in a docker local

docker compose up -d

Add in VMArguments to run in an IDE

-Dspring.profiles.active=local

or

You can run with maven

mvn spring-boot:run -Dspring-boot.run.profiles=local

Development data

You can use the file data.sql to insert data to your local db.

Cleaning DB

All data volume is mapped to directory tmp. You can delete this folder to get rid of development data.

How to test

mvn test

Writing Tests

If you want to use db connection on your test you must extend the class AbstractIntegrationTest. This class will run the docker container and configure the spring datasource.

Dependency check

Dependency check is done automatically during verify phase.

To suppress false positives include the proper information in the file dependency-check-suppressions.xml

More info about this:

https://jeremylong.github.io/DependencyCheck/general/suppression.html

Checkstyle

This project uses Google Java Style. The style will be enforced in build time. Before creating a pull request ensure your code complies to the style by running: mvnw checkstyle:check or mvnw checkstyle:checkstyle to generate the report. You can also install checkstyle plugin on your IDE and set the checkstyle file to checkstyle/google_checks.xml. The checkstyle version used by the maven plugin is the 9.3.

How to contribute

To get more help or find out how to contribute with this project please take a look at this page.

Documentation

See other doc files here.