WebAPI and Database Proof-of-Concept (poc)

This project is a proof-of-concept (POC) web API built using the FastAPI library. It is designed to demonstrate the integration of a web API with a database service, including basic CRUD operations and API key authentication.

Running the application

Setup

1. Clone the Repo

git clone https://github.com/RMI/web-api-poc
cd web-api-poc

2. Create an .env file to store the desired API key, (internal) API port, and DB port.

cp .env.example .env

Run the services with docker compose

# build the image
docker compose build

# run the container
docker compose up --detach

# do both
docker compose up --detach --build

The API and API documentation (Swagger) will be accessible at http://localhost:8000.

Make a request from the API

curl -X 'GET' \
  'http://localhost:8000/scenarios' \
  -H 'accept: application/json' \
  -H 'X-API-Key: abc123'

Defaults to the API key "abc123", but an alternate key (matching what is in your .env file) can be input and submitted on the page.

Shutdown the docker container

docker compose down

# also delete the database volume when shutting down the container
docker compose down --volumes

License

This project is licensed under the MIT License