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.20.0 (2026-11-13). Follow the migration guide when upgrading. See the release and verified artifacts. This checkout prepares unpublished 0.21.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.21.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fastapi_canon-0.21.0.tar.gz | 436.9 kB | With provenance | Details for fastapi_canon-0.21.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fastapi_canon-0.21.0-py3-none-any.whl | Python 3 | none | any | Details for fastapi_canon-0.21.0-py3-none-any.whl |
Total release size: 956.2 kB
Release files / fastapi_canon-0.21.0.tar.gz
| Download URL | fastapi_canon-0.21.0.tar.gz |
|---|---|
| Size | 436.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
18590928a96b81f3c7010b78270f48933db557cf1f4f8c719ca04ffae409b072
|
|
BLAKE2b-256 checksum How to use checksums |
9f9f9d68e1e2e6aab03428bca9a31ee06fe2c752cf1d088948c47c4a7aa83a67
|
| 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 14, 2026.
Transparency logRelease files / fastapi_canon-0.21.0-py3-none-any.whl
| Download URL | fastapi_canon-0.21.0-py3-none-any.whl |
|---|---|
| Size | 519.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
07d10788c30c6c6269d9e64ca64597d51ffb23d7f906e6ee17f754b1752a6cdd
|
|
BLAKE2b-256 checksum How to use checksums |
1489f4c91c7758a54d3256bf1ec3a39928600323e4ea29f405aeb9338d2fa178
|
| 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 14, 2026.
Transparency logSecurity for fastapi-canon 0.21.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.
Attestation for fastapi_canon-0.21.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 14, 2026.
Transparency logA 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.