This crate provides the REST API service executable. It is the interface between the CoverNode and the outside world.

The REST API is defined in docs/rest_api_specification.md.

Run the scripts in the dev folder folder to set up a local cloud stack.

Then, run the following to start the api:

$ kubectl rollout restart deployment api-deployment -n cloud

In the absence of a DATABASE_URL environment variable, sqlx relies on a local JSON file (sqlx-data.json) to statically check the validity of the SQL syntax. Whenever queries are modified, the following command will need to be run in order to generate new query metadata. This file needs to be checked into version control.

$ ./api/scripts/update_sqlx_json.sh