How-To Guides#
Task-focused guides for working with FastAPI-Restly. New to the framework? Start with Getting Started, then the Tutorial; come back here when you have a concrete task.
Adopt Restly beside existing FastAPI routes, then wire it into your sessions and models.
The idiomatic answers: nested resources and sub-resources, a different list schema, restoring soft-deleted rows, webhook receivers, login flows, custom actions, tenant scoping.
Define schemas with field aliases, write-only fields, and read-only computed fields.
Reference related objects by ID with automatic resolution and 404 on missing.
Filter, sort, and paginate list endpoints using URL query parameters.
The typed fr.exc exceptions to raise from overrides, the 422-vs-400 split,
and app-wide error envelopes (problem+json).
Use Python inheritance to share CRUD overrides, dependencies, URL prefixes, and access control across multiple views.
Layer cross-cutting concerns — tenant scoping, soft delete, audit stamping — through cooperative mixins.
Use IDSchema, optional view generics, and typed CRUD methods without
fighting the framework.
Use AsyncReactAdminView to get a backend that ra-data-simple-rest connects to out of the box.
Per-view tags and responses, custom-route metadata, replacing a generated
route’s documented contract, and x-resource-ref.
A copy-paste conftest, savepoint-isolated fixtures, and the full fixture reference.
Production engine config, Alembic migrations, and an ASGI checklist.