README.md

YTI CodeList - Public API Service microservice

This application is part of the Joint metadata and information management programme.

Description

This is the implementation of the Public API Service microservice for the YTI CodeList with:

• Spring boot For getting things up and running
• Embedded Jetty to serve
• Jersey 2 for JAX-RS

Interface Documentation

When the microservice is running, you can get the OpenAPI documentation from:

• http://localhost:9601/codelist-api/api/openapi.json
• http://localhost:9601/codelist-api/api/openapi.yaml
• http://localhost:9601/codelist-api/swagger/index.html

Prerequisities

Building

• Java 8+
• Maven 3.3+
• Docker

Running

• yti-compose - Default configuration for development use

Starting service on local development environment

Running inside IDE

Add the following Run configurations options:

• Program arguments: --spring.profiles.active=local --spring.config.location=../yti-compose/config/application.yml,../yti-compose/config/yti-codelist-public-api-service.yml
• Workdir: $MODULE_DIR$

Add folder for yti project, application writes modified files there:

$ mkdir /data/yti

Building the Docker Image

$ mvn clean package docker:build

Running the Docker Image

$ docker run --rm -p 9601:9601 -p 19601:19601 -v /path/to/yti-codelist-config:/config --name=yti-codelist-public-api-service yti-codelist-public-api-service -a --spring.config.location=/config/application.yml,/config/yti-codelist-public-api-service.yml

.. or in yti-compose run

$ docker-compose up yti-codelist-public-api-service