Routing

Routing is a fundamental aspect of building web applications with Litestar. It involves mapping URLs to the appropriate request handlers that process and respond to client requests.

Litestar provides a flexible and intuitive routing system that allows you to define routes at various layers of your application.

Articles

• Overview
  • Registering Routes
    • Registering routes dynamically
  • Routers
  • Controllers
  • Registering components multiple times
    • Controllers
    • Route handlers
  • Mounting ASGI Apps
• Route handlers
  • Declaring paths
  • “reserved” keyword arguments
  • Type annotations
  • HTTP route handlers
    • Semantic handler decorators
  • Websocket route handlers
  • ASGI route handlers
    • Limitations of ASGI route handlers
  • Route handler indexing
  • Adding arbitrary metadata to handlers
  • Signature namespace
    • Default signature namespace
• Parameters
  • Path Parameters
    • Supported Path Parameter Types
  • The Parameter function
    • Extra validation and documentation for path params
  • Query Parameters
    • Default values
    • Optional parameters
  • Type coercion
  • Alternative names and constraints
  • Header and Cookie Parameters
  • Layered Parameters