README.md

fastapi_play

a repo for playing with FastAPI and Docker

FastAPI app

The app is contained wholely in the 'api' directory. This contains unit tests, and a full ymls for a conda environments (a -test.yml for dev, and a -prod.yml for prod). A development environment can be created (and entered) by

# in fastapi_play/api/
conda env create -f environment-test.yml
conda activate fastapi_play_env

The unit tests can be run using pytest (from the api directory).

# in fastapi_play/api/
python -m pytest

The app can be brought up in a development server by running

# in fastapi_play/api/
python asgi.py

Docker

The docker setup consists of:

• docker-compose.yml
• Dockerfile

Unit tests and builds can be run using

# in fastapi_play/
docker-compose build

and the app can be run (in a container) using

# in fastapi_play/
docker-compose up

FastAPI docs

Once the app is running, one can interact directly with the endpoints. As for all FastAPI apps, there are docs available on the endpoints

• /openapi.json
• /docs
• /redoc