fullapi

Spec-driven FastAPI: generate a project from api.yaml, then enforce it in CI.

Why

Scaffolders help once, then leave. fullapi keeps the spec as the source of truth: gen builds the project, check fails your CI when the API drifts from the spec — a living contract, not a one-shot template.

Quick Start

pip install fullapi

Write api.yaml (or run fullapi init for a starter file):

name: shop_api
database: sqlite        # none | sqlite | postgres
auth: jwt               # optional
resources:
  - name: product
    fields:
      title: str
      price: float
      note: str?        # trailing ? = optional
    auth: true          # protect this resource's routes

Generate and run:

fullapi gen                       # api.yaml -> ./app
pip install -r requirements.txt
uvicorn app.main:app --reload

Enforce in CI:

fullapi check                     # exits non-zero on breaking changes

Commands

Command	Description
fullapi init [spec]	Write a starter api.yaml
fullapi gen [spec] [-o dir]	Generate the project from the spec
fullapi check [spec] [--app app.main:app]	Fail on breaking drift from the spec

How check works

It reads the live app's real app.openapi(), derives the expected schema from api.yaml, and diffs them. Removed routes/fields, type changes, and newly required fields are breaking (non-zero exit); added routes and optional fields are safe.

Built and maintained by @sahilnyk.