Skip to main content

fastapi-canon

Canon adds typed HTTP contracts, SSE, WebSockets and application composition to FastAPI. Define public errors once, reuse them across transports and export contracts for Python and TypeScript clients.

Install

uv add fastapi-canon

Python 3.12–3.14 is supported. Add extras for the features you use, for example fastapi-canon[sse,websockets] or fastapi-canon[codegen].

Published: 0.19.0 (2026-11-10). These docs follow the checkout. Follow the migration guide when upgrading. See the release and verified artifacts. This checkout prepares unpublished 0.20.0; see its migration steps.

Shared error handling

Keep domain exceptions in ordinary Python and declare their public representation:

from fastapi import FastAPI

from fastapi_canon import APIRouter, Composition, Error, Feature


class ProjectMissing(Exception):
    pass


project_missing = Error(
    ProjectMissing,
    status=404,
    code="project_missing",
    title="Project not found",
    detail="Choose another project.",
)
router = APIRouter()


@router.get("/projects/{project_id}", raises=[project_missing])
async def get_project(project_id: int) -> dict[str, int]:
    if project_id == 0:
        raise ProjectMissing()
    return {"id": project_id}


app = Composition(
    features=(Feature(name="projects", routers=[router]),),
).build(FastAPI())

GET /projects/0 returns a 404 RFC 9457 Problem Details response. OpenAPI describes the same error; exception messages stay private by default. Reuse project_missing in SSE and RPC declarations. See the quickstart for the complete server and clients.

What you can build

Task Guide
HTTP routes, dependencies and feature lifecycles Composition
Shared public errors and typed extensions Problems
File uploads and binary downloads File transfers
Typed event streams SSE
RPC, sockets and binary streams WebSockets
Media sessions, tools or database resources WebRTC, MCP, database
Service tracing and request logs Telemetry, logging

Generate and check clients

The generation workflow exports contracts and runs specialized SSE, WebSocket and WebRTC generators. Add your HTTP generator through external commands. Configure it with the generation guide, then run:

uv run fastapi-canon generate
uv run fastapi-canon generate --check --diff
uv run fastapi-canon check errors src --strict --require-complete

Python models and error declarations are shared on the server. Generated clients have separate APIs and error classes. Static checks complement runtime tests and report paths they cannot resolve.

Browse the task guides, examples or contributor commands. Coding agents can install the bundled backend skill with uv run fastapi-canon skill install.

Metadata

Release files for fastapi-canon 0.20.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fastapi-canon 0.20.0
File Size Uploaded Provenance Actions
fastapi_canon-0.20.0.tar.gz 421.0 kB With provenance Details for fastapi_canon-0.20.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fastapi-canon 0.20.0
File Interpreter ABI Platform Actions
fastapi_canon-0.20.0-py3-none-any.whl Python 3 none any Details for fastapi_canon-0.20.0-py3-none-any.whl

Total release size: 920.5 kB

Release files / fastapi_canon-0.20.0.tar.gz

Download URL fastapi_canon-0.20.0.tar.gz
Size 421.0 kB
Tags Source
SHA-256 checksum
How to use checksums
15dab723a2bc71d2ada01c9fd0217097e8cd5d3450fe02b4fe5a98fae2997302
BLAKE2b-256 checksum
How to use checksums
9bebe11626213cfdc8db7718ce9ba96d2bd77235b4037c94c65add27e48891a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Release files / fastapi_canon-0.20.0-py3-none-any.whl

Download URL fastapi_canon-0.20.0-py3-none-any.whl
Size 499.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7692ea11c24801072290e5233a1aa07f3018bba0a6454ebd9aa7e797b5600bf5
BLAKE2b-256 checksum
How to use checksums
1ce7905c928693812dcc61be86b28fa905a27f08e94fe724a2953df1d22c20e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Security for fastapi-canon 0.20.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for fastapi_canon-0.20.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page