jableader
4c3f370ddc
commit 4189d9f824f681b480f797b109e963762eb22e9c
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 16:41:57 2025 +1100
Openapi complete
commit bebf8c30cba0b85a889198fe44879614065a0c34
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 16:35:39 2025 +1100
Removed unversioned api
commit dd9cc2eae75d66fceebe14c918c3ed8498376ee6
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 16:07:03 2025 +1100
Spec updates
commit b993c4530688f79ea983278283f984e9d8e83860
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 16:01:50 2025 +1100
docs(spec): update doof-back-spec with v1 RFC7807 422, reusable Problem* responses, and shopping/current aliasing; tests passing; openapi.json refreshed
commit 30bac7e57367b14ce924667a7955845de949d779
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 16:00:13 2025 +1100
openapi polish
commit eb7f7f224f7085fa5b3fadc7716db0ebb7f47eb0
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:54:52 2025 +1100
OpenAPI reusable responses: Added components.responses for `Problem400`, `Problem404`, and `Problem422`; v1 routes reference these consistently.
- Units enum: Exposed advisory enum in schema for `Ingredient.unit` using existing units list (no runtime enforcement).
commit 037037e17d684a89b264f2406377970a0de7ec99
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:43:01 2025 +1100
Add `total` counts to v1 page responses for recipes/persons; push persons name filter into SQL for v1 when `q` is provided.
commit 07e7735076aae8cbd04bb10f9aa324c1a3d80ae4
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:40:17 2025 +1100
Add parameter descriptions for `cursor`, `limit`, and `q` on v1 list endpoints; include example `Page` envelopes in 200 responses.
commit e5bf9396b0fe870501d1b4712cba2555dd2ef9b1
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:36:27 2025 +1100
DB pagination
commit 782315cd2a0c18cc50e4deaf28e7ec6e4b58c6e2
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:29:38 2025 +1100
camelcase tests
commit b207c33e2844c00fc9e531fb9cf8c07a3f5cd543
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:24:57 2025 +1100
OpenAPI enrichment, Error responses
commit dc84681ab743008e5cd8bec7f3ccb0d05b557518
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:16:39 2025 +1100
v1 tests: Added basic tests to assert `Page` envelopes and RFC7807 responses for v1 endpoints without affecting legacy tests.
commit 1524b7a98ffe04af11c2731c8125ac9348751cff
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:14:51 2025 +1100
Pagination
commit 92e91d7acf15c09b14bc76f7b16a7a47e65129ec
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:03:50 2025 +1100
Use middleware for naming case changes
commit c68f964f9b8e3d8f8ef020661e747e0990459c81
Author: jableader <jacobdunk@gmail.com>
Date: Sat Oct 18 15:00:09 2025 +1100
Openapi gen
69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
Meal planner backend
|
|
|
|
## Structure
|
|
|
|
- `main.py`: FastAPI app with all HTTP endpoints.
|
|
- `db.py`: aiosqlite connection + schema bootstrap across subpackages.
|
|
- Domain packages with models and persistence:
|
|
- `products/` (db, scrapers for Woolworths/Coles)
|
|
- `ingredients/`
|
|
- `recipes/` (db, scraping)
|
|
- `meals/`
|
|
- `persons/`
|
|
- `shopping/`
|
|
- `tests/`: unit and API tests with sample HTTP fixtures.
|
|
|
|
## Getting started
|
|
|
|
Install packages
|
|
```
|
|
pip install -r ./requirements.txt
|
|
```
|
|
|
|
Run API (dev)
|
|
```
|
|
uvicorn main:app --reload
|
|
```
|
|
|
|
Run tests
|
|
```
|
|
python -m unittest -q
|
|
```
|
|
|
|
## Tooling
|
|
|
|
This repo includes baseline configs in `pyproject.toml`:
|
|
- black (format)
|
|
- ruff (lint)
|
|
- mypy (type check)
|
|
|
|
Optional commands (install these locally first):
|
|
```
|
|
ruff check .
|
|
black .
|
|
mypy .
|
|
```
|
|
|
|
## Environment variables
|
|
|
|
- DOOF_DB: Path to sqlite database (default: `./data/doof.sqlite`)
|
|
- DOOF_PORT: Port the server listens on when containerized; align Dockerfile `EXPOSE` accordingly.
|
|
|
|
## OpenAPI schema
|
|
|
|
- Generate the schema artifact used by the frontend and CI checks:
|
|
```
|
|
python scripts/export_openapi.py
|
|
```
|
|
|
|
This writes `openapi.json` to the repo root. Versioned endpoints live under `/api/v1`, legacy under `/api` (deprecated with `Deprecation` header).
|
|
|
|
## Schema lint/diff (manual)
|
|
|
|
Optionally, lint and compare schemas locally using Node tools:
|
|
```
|
|
npx -y @stoplight/spectral-cli lint openapi.json
|
|
npx -y openapi-diff --fail-on-changed --fail-on-incompatible path/to/baseline.json openapi.json
|
|
```
|
|
|
|
Keep a `baseline.json` on release branches to detect breaking changes.
|