API Reference

The API reference is generated from the source docstrings. The pages below group the core and selected multiworker integration surfaces by subsystem; private implementation helpers are not an API guarantee.

• Core
  • Server
  • Applications (contract)
  • Request and response
  • Registry, lifespan and pool
  • Exceptions and types
• Applications
  • OpenAPI
  • MCP
  • Server application
  • Server sections
• Authentication
  • AuthMixin
  • AuthCore
  • AuthMethod
  • PasswordMethod
  • safe_next_path()
  • OidcMethod
  • UserStore
  • FileUserStore
  • ApiKeyStore
  • FileApiKeyStore
• Sessions
  • SessionMixin
  • Session
  • Avatar
  • SessionStore
  • MemorySessionStore
• Middleware
  • BaseMiddleware
  • build_chain()
  • cookie_value()
  • headers_dict()
  • MiddlewareMixin
  • default_registry()
  • ErrorMiddleware
  • WellKnownMiddleware
  • LoggingMiddleware
  • CORSMiddleware
  • AuthMiddleware
  • SessionMiddleware
• Tasks
  • TaskGrammar
  • TaskMixin
  • TaskManager
  • TaskSpool
  • new_descriptor()
  • LocalTaskExecutor
  • TaskScheduler
  • TaskCadence
  • EverySpec
  • CronSpec
  • AtSpec
  • TaskStore
  • FileTaskStore
  • EventHub
• Configuration
  • AsgiConfigBuilder
  • BaseConfiguration
  • AsgiServerGrammar
  • ConfigError
  • ConfigurationHandler
  • Database handler
• Channel and communication
  • CommunicationMixin
  • ChannelClient
  • FrameTooLarge
  • Frame
  • FrameCodec
• Storage
  • DEFAULT_SITE_MOUNT
  • StorageMixin
• Plugins
  • PluginMixin
  • default_plugin_registry()
  • OpenAPIPlugin
  • OpenAPITranslator
• WebSocket and WSX
  • WebSocket
  • WebSocketRegistry
  • WsxConnection
  • WsxEnvelope
• Multiworker SPA integration
  • Front and worker
  • Hosted application adapters
  • Global store