Examples

Examples

• Applies to: Flask and FastAPI
• Best source: examples/README.md
• Related pages: Quickstart (Flask), Quickstart (FastAPI), RPC

This page is a task-based catalog of the examples that currently exist in the repository.

Getting started

• examples/mini_app.py — smallest Flask app
• examples/mini_fastapi_app.py — smallest FastAPI app

Relationships and includes

• examples/demo_relationship.py — simple User / Book relationship example
• examples/mini_examples/ex04_relationship.py — compact relationship example
• examples/mini_examples/ex05_secret_relationship.py — hidden relationship exposure

Filtering and search

• examples/mini_examples/ex06_filtering.py — custom filtering strategy
• examples/mini_examples/ex11_search.py — search helper method exposure

Serialization and computed attributes

• examples/mini_examples/ex01_to_dict.py — override to_dict
• examples/mini_examples/ex03_jsonapi_attr.py — computed attributes with @jsonapi_attr

RPC / custom methods

• examples/mini_examples/ex08_rpc.py — JSON:API RPC basics
• examples/demo_pythonanywhere_com.py — broad Flask showcase
• examples/demo_fastapi.py — broad FastAPI showcase

Hooks, permissions, and auth

• examples/mini_examples/ex15_http_hook.py — HTTP lifecycle hooks
• examples/mini_examples/ex16_perm.py — _s_check_perm
• examples/authentication/demo_auth.py — HTTP Basic auth
• examples/authentication/demo_jwt.py — JWT auth example
• examples/authentication/demo_post_auth.py — write-method auth

Stateless services

• examples/demo_stateless.py — stateless resource example
• examples/mini_examples/ex09_stateless.py — mini stateless example
• examples/mini_examples/ex10_jabase.py — JABase

OpenAPI / Swagger customization

• examples/mini_examples/ex12_swagger.py — custom swagger metadata
• examples/mini_examples/ex13_prefix.py — custom URL prefix
• examples/mini_examples/ex14_flask_dispatch.py — Flask dispatch integration

Deployment / containers

• examples/docker_sqlite_demo/README.md — SQLite-only demo container

Special topics

• examples/demo_geoalchemy.py — GeoAlchemy / PostGIS
• examples/demo_full.py — compatibility wrapper
• examples/demo_devto.py — compact older demo variant

Legacy note

Older expose-existing-database material belongs on Existing Databases (Legacy), not in the main example catalog.