RadarCOVID Configuration Service
Introduction
Configuration Service in terms of the Radar COVID project enables:
- Getting exposition settings to be used by apps.
- Getting list of Autonomous Communities and their information.
- Getting languages available: es-ES, ca-ES, en-US,...
Prerequisites
These are the frameworks and tools used to develop the solution:
- Java 11.
- Maven.
- Spring Boot version 2.3.
- Lombok, to help programmer. Developers have to include the IDE plugin to support Lombok features (ie, for Eclipse based IDE, go here).
- ArchUnit is used to check Java architecture.
- PostgreSQL.
- Testing:
- Spock Framework.
- Docker, because of using Testcontainers.
- Testcontainers.
Contentful is also used as content platform to manage literals for the different languages, etc.
Installation and Getting Started
Building from Source
To build the project, you need to run this command:
mvn clean package -P<environment>
Where <environment>
has these possible values:
local-env
. To run the application from local (eg, from IDE o from Maven usingmvn spring-boot:run
). It is the default profile, usingapplication-local.yml
configuration file.docker-env
. To run the application in a Docker container withdocker-compose
, usingapplication-docker.yml
configuration file.pre-env
. To run the application in the Preproduction environment, usingapplication-pre.yml
configuration file.pro-env
. To run the application in the Production environment, usingapplication-pro.yml
configuration file.
All profiles will load the default configuration.
Running the Project
Depends on the environment you selected when you built the project, you can run the project:
- From the IDE, if you selected
local-env
environment (or you didn't select any Maven profile). - From Docker. Once you build the project, you will have in
configuration-server-boot/target/docker
the files you would need to run the application from a container (Dockerfile
and the Spring Boot fat-jar).
If you want to run the application inside a Docker container in local, once you built it, you should run:
docker-compose up -d postgres
docker-compose up -d backend
Database
This project doesn't use either Liquibase or Flyway because:
- DB-Admins should only have database privileges to maintain the database model (DDL).
- Applications should only have privileges to maintain the data (DML).
Because of this, there are two scripts:
01-CONFIGURATION-DDL.sql
. Script to create the model.02-CONFIGURATION-DML.sql
. Script with inserts.
API Documentation
Along with the application there comes with OpenAPI Specification, which you can access in your web browser when the Verification Service is running (unless in Production environment, where it is inactive by default):
<base-url>/openapi/api-docs
If running in local, you can get the OpenAPI accessing http://localhost:8080/openapi/api-docs. You can download the YAML version in /openapi/api-docs.yaml
.
You can get a copy here.
Endpoints
Endpoint | Description | Default values | Sample response |
---|---|---|---|
/masterData/ccaa?locale=<locale>[&additionalInfo=<additionalInfo>] |
Get Autonomous Communities available | locale=es-ES additionalInfo=false |
Response with additionalInfo=true :response-masterData-ccaa-additionalInfo.json |
/masterData/locales?locale=<locale> |
Get locales available | locale=es-ES |
response-masterData-locales.json |
/settings |
Get application settings | response-settings.json |
|
/texts?ccaa=<ccaa>[&locale=<locale>] |
Get texts by locale and Autonomous Community | ccaa=ES locale=es-ES |
Response with default parameters.response-texts.json |
Modules
Configuration Service has four modules:
configuration-server-parent
. Parent Maven project to define dependencies and plugins.configuration-server-api
. DTOs exposed.configuration-server-boot
. Main application, global configurations and properties. This module also has integration tests and Java architecture tests with ArchUnit:configuration-server-service
. Business and data layers.
Support and Feedback
The following channels are available for discussions, feedback, and support requests:
Type | Channel |
---|---|
Issues |
Contribute
If you want to contribute with this exciting project follow the steps in How to create a Pull Request in GitHub.
More details in CONTRIBUTING.md.
License
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.