api

This subdirectory contains the API component of PAVI.

The API code is written in python, so follows the general dependency management and python PAVI coding guidelines.

The API is built using the fastAPI framework.

Development

During active code development, run the API server through the following command:

make run-server-dev

This will run an API server which automatically reloades when code changes are saved, and make the API available at http://localhost:8000/.

Local invocation and testing instructions

To build the docker image:

make docker-image

To build a clean docker image (without using caching, for troubleshooting potential caching issues):

make clean docker-image

Then to run the container locally:

make run-container-dev

While this is running, the API should be available at http://localhost:8080/.