API Quickstart
The following guide will describe how to get the Fidescls API going, step-by-step.
System Requirements
Docker and Docker-Compose are the only requirements here.
- Install
docker
locally (see Docker Desktop or your preferred installation). The minimum verified Docker version is20.10.8
- If your
docker
installation did not includedocker-compose
, make sure to get at least version1.29.0
. Installation instructions can be found here. Make
is an additional requirement should you wish to run the container without having to create adocker-compose
configuration.
Using Make
If taking advantage of the Makefile
, the following commands can be used from the root fidescls
directory:
make cli
: In addition to spinning up the API, this will drop you into a shell within the container. This can be used to explore, debug, etc. within the container.make api
: This will spin up the API and display the logs to the terminal.
Manual Docker Setup
This is a reference file that you can copy/paste into a local docker-compose.yml
file. It will create spin up the Fidescls API server. Make sure that you don't have anything else running on port 8765
before using this file.
docker-compose.yml | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
Now we can start interacting with our installation. You can run the following commands to get going:
docker-compose up -d
-> This will spin up the docker-compose file in the backgrounddocker-compose run --rm fidescls /bin/bash
-> Opens a shell within the fidescls container
Check Status
To ensure that the API is running and healthy, the following GET request can be sent to the health
endpoint:
1 2 |
|
Next Steps
Now that you've got the API server up and running, you are ready to start making requests! Check out the Requests page for some guidance and examples.