crumbs API

Crumbs is a personal recipe API built with FastAPI, SQLModel, and SQLite.

Features

• Public read endpoints for recipes
• API key-protected write endpoints (create, update, delete)
• Search recipes by title or ingredient

Tech Stack

• Python 3.13
• FastAPI
• SQLModel
• SQLite
• uv

Quick Start

1. Create and sync environment:

uv sync

2. Set an API key:

cp .env.example .env

3. Run the API:

uv run uvicorn app.main:app --reload

The API will be available at http://127.0.0.1:8000. Interactive docs: http://127.0.0.1:8000/docs.

API Key Authentication

Write endpoints require the X-API-Key header:

X-API-Key: your-secret-key

Endpoints

• GET /health - health check
• GET /recipes - list recipes (optional search query)
• GET /recipes/{recipe_id} - get a recipe by ID
• POST /recipes - create recipe (protected)
• PATCH /recipes/{recipe_id} - update recipe (protected)
• DELETE /recipes/{recipe_id} - delete recipe (protected)