Skip to content

AAFC DINA agent module implementation / Implémentation du module de Agent DINA de AAC

License

Notifications You must be signed in to change notification settings

AAFC-BICoE/agent-api

Repository files navigation

agent-api

AAFC DINA agent module implementation.

See DINA agent module specification.

Required

  • Java 21
  • Maven 3.8 (tested)
  • Docker 19+ (for running integration tests)

Documentation

To generate the complete documentation:

mvn clean compile

The single HTML page will be available at target/generated-docs/index.html

To Run

For testing purpose a Docker Compose and .env file are available in the local folder. PostgreSQL 12 is required and included in docker-compose example.

Create a new docker-compose and .env file from the example:

cp local/docker-compose.yml.example docker-compose.yml
cp local/*.env .

Start the app (default port is 8082):

docker-compose up

Once the services have started you can access the endpoints at http://localhost:8082/api/v1/person

Cleanup:

docker-compose down

Testing

Run tests using mvn verify. Docker is required, so the integration tests can launch an embedded Postgres test container.

About

AAFC DINA agent module implementation / Implémentation du module de Agent DINA de AAC

Topics

Resources

License

Stars

Watchers

Forks