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 handlers, 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.
Use IDSchema, optional view generics, and typed perform_* handlers without fighting the framework.
Customize perform_* handlers, replace generated routes, and add custom routes alongside generated CRUD.
Use AsyncReactAdminView to get a backend that ra-data-simple-rest connects to out of the box.
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. Includes the rule for when to layer in a mixin vs.
write logic in perform_create / perform_update.
Filter, sort, and paginate list endpoints using URL query parameters.
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.
Adopt Restly beside existing FastAPI routes, then wire it into your sessions and models.
Schema generation internals, view registration, and list-parameters lifecycle.