API Reference

Audience: All users looking for detailed API documentation.

This section provides comprehensive reference documentation for ActingWeb’s APIs, configuration options, and module interfaces.

Contents

• Interface API
  • ActingWebApp
  • ActorInterface
  • Hooks Registry
  • Integrations
  • Runtime Context
  • Authentication
• Hooks Reference
  • Overview
  • Property Hooks
  • Callback Hooks
  • Application Callback Hooks
  • Subscription Hooks
  • Lifecycle Hooks
  • Method Hooks
  • Action Hooks
  • Async/Await Support
  • API Discovery
  • Matching & Ordering
  • Path Semantics (Properties)
• actingweb.handlers package
  • Submodules
  • actingweb.handlers.base_handler module
  • actingweb.handlers.bot module
  • actingweb.handlers.callback_oauth module
  • actingweb.handlers.callbacks module
  • actingweb.handlers.factory module
  • actingweb.handlers.meta module
  • actingweb.handlers.oauth2_callback module
  • actingweb.handlers.oauth2_endpoints module
  • actingweb.handlers.properties module
  • actingweb.handlers.resources module
  • actingweb.handlers.root module
  • actingweb.handlers.subscription module
  • actingweb.handlers.trust module
  • actingweb.handlers.www module
• Routing Overview
  • Integration
  • Core Actor Routes
  • Web UI Routes (when with_web_ui(True))
  • Authentication
  • Base Paths
  • Actor Root Endpoint Behavior
  • Notes
• Database Backends Reference
  • Quick Comparison
  • When to Use DynamoDB
  • When to Use PostgreSQL
  • Performance Characteristics
  • Cost Analysis
  • Migration Between Backends
  • Implementation Details
  • Recommendations by Scenario
  • See Also
• Security Cheatsheet
  • Properties and Hooks
  • Access Control
  • OAuth2
  • Mobile OAuth2
  • Custom Routes
  • Web UI
  • Data Backend
• actingweb code
  • Subpackages
  • Submodules
  • actingweb.actor module
  • actingweb.attribute module
  • actingweb.auth module
  • actingweb.aw_proxy module
  • actingweb.aw_web_request module
  • actingweb.config module
  • actingweb.peertrustee module
  • actingweb.property module
  • actingweb.subscription module
  • actingweb.trust module
  • actingweb.runtime_context module
  • actingweb.request_context module
  • actingweb.logging_config module
  • actingweb.log_filter module
• actingweb.db.dynamodb package
  • Submodules
  • actingweb.db.dynamodb.actor module
  • actingweb.db.dynamodb.attribute module
  • actingweb.db.dynamodb.peertrustee module
  • actingweb.db.dynamodb.property module
  • actingweb.db.dynamodb.subscription module
  • actingweb.db.dynamodb.subscription_diff module
  • actingweb.db.dynamodb.trust module

High-Level API

Interface API

Documentation for ActingWebApp, ActorInterface, and the modern fluent configuration API.

Hooks Reference

Complete reference for all hook decorators and their signatures.

HTTP Handlers

Handlers

Reference for all HTTP handler classes and their methods.

Routing Overview

Complete list of routes, browser redirect behavior, and content negotiation rules.

Database Backends

Database Backends

Detailed comparison of DynamoDB and PostgreSQL backends, performance characteristics, cost analysis, and migration guide.

Configuration & Security

Security

Security best practices and configuration checklist.

Module Reference

actingweb

Auto-generated documentation for the actingweb package.

actingweb.db.dynamodb

Documentation for the DynamoDB database backend.

Quick Links

Common tasks and their reference sections:

Task	Reference
Configure the app	Interface API
Choose database backend	Database Backends Reference
Register hooks	Hooks Reference
Understand routing	Routing Overview
Security checklist	Security Cheatsheet
Handler methods	actingweb.handlers package

See Also

• Configuration Reference - Configuration guide

• Hooks - Hooks tutorial

• Developer API - Developer API guide