contacts-api

This project can serve as a backend for a very simple contact information store.

For anyone who may find this very basic information enough:

• lastname
• initials
• firstname
• street
• house_number
• postalcode
• residence
• phone_number

Feel free to use this code.

I have developed this Web API with the following components.

• FastAPI
• FastAPI CRUDRouter
• API Key authentication inspiration from: https://nilsdebruin.medium.com/fastapi-authentication-revisited-enabling-api-key-authentication-122dc5975680

With a PostgreSQL database in mind.

Use these environment variables:

To authenticate with the API, make a header entry in the HTTP request named "access_code" and then fill in whatever code you have put in: "CONTACTS_API_KEY"

The rest of the settings are for the database. I suggest another container.

• CONTACTS_DATABASE_HOST
• CONTACTS_DATABASE_PORT
• CONTACTS_DATABASE_DB
• CONTACTS_DATABASE_USER
• CONTACTS_DATABASE_PASSWORD

Example docker-compose

For use in Portainer of with docker-compose.

---

networks:
  contacts-api:
    external: false

services:
  server:
    image: djongepier/contacts-api:latest
    container_name: contacts-api
    environment:
      - USER_UID=1000
      - USER_GID=1000
      - CONTACTS_API_KEY=<your super secret key>
      - CONTACTS_DATABASE_HOST=db
      - CONTACTS_DATABASE_PORT=5432
      - CONTACTS_DATABASE_DB=contacts-api
      - CONTACTS_DATABASE_USER=contacts
      - CONTACTS_DATABASE_PASSWORD=contacts
    restart: always
    networks:
      - contacts-api
    ports:
      - <your port>:80
    depends_on:
      - db
   
  db:
    image: postgres:14
    restart: always
    environment:
      - POSTGRES_USER=contacts
      - POSTGRES_PASSWORD=contacts
      - POSTGRES_DB=contacts-api
    networks:
      - contacts-api
    volumes:
      - <your directory or volume>:/var/lib/postgresql/data

Example development container.

docker run --name postgres -e POSTGRES_PASSWORD=contacts -e POSTGRES_USER=contacts -e POSTGRES_DB=contacts-api -p 5432:5432 postgres:14-alpine

To start the project for testing.

uvicorn main:app --reload