litestar-routing

What problem does it solve?

Design and implement Litestar routing with app/router/controller composition, handler decorators, path and parameter modeling, route indexing, reverse lookups, ASGI mounting, and layered route metadata. Use during creation or refactoring of endpoint topology and URL contracts to ensure scalable, maintainable APIs.

Core Features & Use Cases

• App-level registration and router/controller composition to organize endpoints and shared behavior.
• Semantic decorators (e.g., @get, @post) with explicit path definitions and parameter typing for clear OpenAPI generation.
• Route indexing, named operations, and deterministic reverse routing to support policy hooks and client code generation.
• Layered metadata propagation across app/router/controller boundaries for consistent guards and behavior.
• Use case: evolve a large Litestar API without breaking existing URL contracts.

Quick Start

Create a new endpoint with a typed handler decorated by @get("/items/{item_id}") mounted under a Router and Controller to validate path, method, and reverse routing behavior.