2. InstallationΒΆ

For running the collection-api service you may either startup a docker container or you build and run the service from source. The source code is available at https://github.com/kit-data-manager/collection-api For more information about compiling and starting from source, please refer to the README located in the source repository. In the following, running the collection-api service using docker is explained.

Prerequisites:

  • docker (tested with 19.03.8).
You can create an instance of the collection-api service by running docker:
$ docker run -d -p 8080:8080 kitdm/collection-api:latest

Unable to find image 'kitdm/collection-api:latest' locally
latest: Pulling from kitdm/collection-api
3192219afd04: Pull complete
17c160265e75: Pull complete
cc4fe40d0e61: Pull complete
9d647f502a07: Pull complete
[...]
Status: Downloaded newer image for kitdm/collection-api:latest

As soon as the microservice is started, you can browse to http://localhost:8080/swagger-ui.html in order to use the available REST APIs.