Customization

Customization

• Applies to: Flask and FastAPI
• Best examples: examples/demo_fastapi.py, examples/demo_pythonanywhere_com.py
• Related pages: Serialization and jsonapi_attr, HTTP Methods and Hooks, Endpoint Decorators, OpenAPI / Swagger Customization

Use this page as a map to the main customization mechanisms in SAFRS.

Serialization customization

Use Serialization and jsonapi_attr when you need to:

• override to_dict
• expose computed attributes
• add writable computed properties with setters
• hide attributes or relationships

HTTP methods and hooks

Use HTTP Methods and Hooks when you need to:

• restrict allowed CRUD methods with http_methods
• override _s_post or _s_patch
• implement hook-style behavior around writes

Endpoint decorators and auth

Use Endpoint Decorators and Security and Access Control when you need:

• decorators on model endpoints
• relationship-level decorators
• auth examples
• permission hooks such as _s_check_perm

OpenAPI / Swagger customization

Use OpenAPI / Swagger Customization for:

• custom swagger/openapi fragments
• docstring-driven docs
• prefix and dispatch customizations

Column and relationship exposure

See:

• Column Types
• Relationships and Includes
• Serialization and jsonapi_attr

Configuration

See Configuration Reference for pagination limits, relationship toggles, and config strategy.