Skip to content
Snapshot of the v0.2 release. Fixes and additions since then are not in it. Current documentation →
Documentation
Guides

Guides

Task-oriented walkthroughs. Each page covers one part of the framework and assumes you have already been through Getting Started.

Working with data

Filtering, Ordering & Pagination
The filter tag, range filters, the order parameter and the list envelope.
Validation
validate tags on input types, and registering your own.
Relations
Belongs-to, has-many, and choosing between nesting and a bare ID.
Transactions
Which operations are transactional, and how to join one.

Shaping the API

Errors & Responses
The error types, their status codes, and custom mapping.
Paths & Route Config
Change a mount path or restrict which routes exist.
Custom Actions
Non-CRUD endpoints on a resource.
OpenAPI & Docs UI
The merged document, Swagger UI and ReDoc.

Extending and hardening

Hooks & Overrides
Run logic around an operation, or replace a generated method.
Authentication
Authenticator objects, per-route policy and the built-in schemes.
Testing
Drive a real resource over HTTP against in-memory SQLite.