This is the API service of the CODE Library backend. The purpose of this service is to provide an interface for interacting with the backend services. It exposes a REST-API, which is used by clients to access the services of the library.
For more detailed information about the REST API, refer to REST-API.yml.
The REST API documentation uses the Open API specification.
There are two supported ways to run the service, either locally or inside a Docker container. Please refer to the repositores root README file to learn more about how to build the service for the respective target.
The service can be configured by environment variables.
Depending on if the service is run locally or inside a Docker container the specification of them changes.
For running it locally, please refer to your shells documentation on how to specify them.
For Docker, the environment variables can be passed to docker run with the -e argument.
For configuration during development the use of an environment configuration file is supported.
This file has the name .env and must contain the environment variables for configuration.
The service will automatically look for such a file in the work directory and apply it.
The configuration from the .env file will superseed the configuration specified on the command line.
Variables with a value in the default column are only required to set if the value needs to be changed.
| Variable name | Default | Data type | Description |
|---|---|---|---|
SERVICE_SOCKET |
127.0.0.1:8080 |
IP socket address | IP socket address on which the service listens for HTTP requests. |
IDENTITY_SOCKET |
No default | IP socket address | IP socket address on which the service expects the identity service. |
BOOK_SOCKET |
No default | IP socket address | IP socket address on which the service expects the book service. |