Simple Key-Value Store with FastAPI and DynamoDB

This is a simple example of a key-value store built using FastAPI and DynamoDB. All data is stored in a single DynamoDB table using single-table design.

API Features

1. CRUD operations on JSON data based on api key that in DynamoDB table.
2. Authentication and rate limiting by api key
3. Limit maximum payload size to 400KB

DynamoDB Table Structure

PK	SK	VALUE
String	String	String

1. Composite primary key (PK, SK)
2. Partition Key is PK
3. Sort Key is SK
4. Value is always a JSON string

API Key model structure

PK	SK	VALUE
API_KEY#{api_key}	API_KEY#{api_key}	{"id": {user_id}, "name": {name} }

Record model structure

PK	SK	VALUE
USER#{user_id}	RECORD_KEY#{key_id}	{...}

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

1. Python 3.8+
2. AWS CLI configured with appropriate permissions to access DynamoDB
3. FastAPI
4. Uvicorn

Installation

1. Clone the repository

   git clone https://github.com/gzog/dynamodb-simple-json-api

2. Navigate to the project folder

   cd dynamodb-simple-json-api

3. Install required Python packages

   poetry install

4. Run local DynamoDB server

   docker-compose up

5. Create local DynamoDB table

   ./scripts/create-table.sh

6. Create api key needed to access the API

   ./scripts/create-user.sh

Running the API Server

Run the Uvicorn server from the command line:

./scripts/run.sh

Open your browser and navigate to http://localhost:8000/docs to view the interactive FastAPI documentation.

Endpoints

• GET /records/keys: Retrieve all keys of records
• GET /records: Retrieve all records
• GET /records/{key}: Retrieve a value by its key.
• POST /records/{key}: Insert a new key-value pair. The request body should contain a JSON object.
• PUT /records/{key}: Update the value for an existing key. The request body should contain the new value.
• DELETE /records/{key}: Remove a key-value pair by its key.