Hikit - OSM microservice

Hikit OSM is a microservice keeping track of OSM trail data. The microservice main purpose is to provide the Hikit service with trail related OSM data - communicating changes, helping keeping data synchronized.

Build

Prerequisites

• JDK 17
• Maven 3

Development build

After cloning the repo, simply run mvn install -f root/pom.xml.

Deployment Build

To include all dependencies in a portable uber-jar, run mvn install -P package.

Test

There are two main types of tests written to address the Hikit QA: unit test and integration test. The latter requires the dependencies to be up and running as it tests application operations connecting to them. Once the dependencies are made available, to run the integration tests, simply execute mvn install -P it.

Run

Dependencies

Hikit OSM requires the following service up and running in order to fully operate:

• MongoDB 4.x

To get these up and running in the least time possible, use the included docker-compose.yml:

cd docker
sh rset_download.sh
docker-compose up

Mind that the above set-up is for test/dev only as all services are exposed in the network and they do not use authentication.

Hikit on Docker

In case you want to test run Hikit in combination with all its dependencies:

• Run a deployment build (see Deployment build)
• Run sh docker/build.sh
• Run docker-compose -f ./docker/docker-compose.yml -f ./docker/docker-compose.cluster.yml up The service will be available at http://localhost:8990/api/v<N> (where <N> stands for the version number)

Production

Since it does not support authentication, Hikit OSM should run in a DMZ, not reachable from the outer word.

Properties

Configure the application.properties file to fit the application runtime to your needs. For more on the system properties, check out the repo wiki pages.

The API

OpenAPI

By default, the openAPI v3 specs are exposed at api/v1/api-docs. Alternatively, to interact directly with the REST API, the Swagger UI can be found at api/v1/api-ui.html.