TIS Trainee Reference

About

This is a Spring Boot microservice which provides a REST API for retrieving and managing reference data, such as Gender and Grade, to be used as lists of allowed values.

Developing

Running

gradlew bootRun

Pre-Requisites

• A MongoDB instance.

Environmental Variables

Name	Description	Default
DB_HOST	The MongoDB host to connect to.	localhost
DB_PORT	The port to connect to MongoDB on.	27017
DB_NAME	The name of the MongoDB database.	reference
DB_USER	The username to access the MongoDB instance.	admin
DB_PASSWORD	The password to access the MongoDB instance.	pwd
AUTH_SOURCE	The authentication database.	admin
ENVIRONMENT	The environment to log events against.	local
SENTRY_DSN	A Sentry error monitoring Data Source Name.

Usage Examples

Create a Reference Value

POST /reference/api/{reference_type}

Get all Reference Values

GET /reference/api/{reference_type}

Update a Reference Value

PUT /reference/api/{reference_type}

Delete a Reference Value

DELETE /reference/api/{reference_type}/{tisId}

Testing

The Gradle test task can be used to run automated tests and produce coverage reports.

gradlew test

The Gradle check lifecycle task can be used to run automated tests and also verify formatting conforms to the code style guidelines.

gradlew check

Building

gradlew bootBuildImage

Versioning

This project uses Semantic Versioning.

License

This project is license under The MIT License (MIT).