User Guide#
In-depth coverage of every FastAPI-Restly feature. Start with the tutorial if you are new to the framework; jump to any topic guide if you are looking for something specific.
Tutorial#
A walkthrough that builds a complete blog API from scratch, introducing the core patterns progressively.
Models, schemas, generated endpoints, read/write field control, querying lists, and testing.
Override hooks, low-level object helpers, custom routes, and shared base classes.
Topic Guides#
Define schemas with field aliases, write-only fields, and read-only computed fields.
Customize on_* hooks and add custom routes alongside generated CRUD.
Use Python inheritance to share CRUD overrides, dependencies, URL prefixes, and access control across multiple views.
Use V1 (JSONAPI-style) and V2 (HTTP-style) query parameter interfaces.
Reference related objects by ID with automatic resolution and 404 on missing.
Use RestlyTestClient and savepoint-based pytest fixtures for isolated tests.
Full fixture reference with isolation model details and async test setup.
Plug FastAPI-Restly into a project that already manages its own sessions.
Schema generation internals, view registration, and query modifier lifecycle.