Routing¶

Learn how to define routes and handle requests in your Ravyn application.

Conceptual map¶

Decorator or Gateway
   -> Router / Include composition
   -> optional middleware/permissions/dependencies
   -> handler execution

Use this section when you need to move from a few endpoints to a maintainable route tree.

flowchart TD
    App["Ravyn"] --> Include["Include"]
    App --> Router["Router"]
    Include --> Router
    Router --> Gateway["Gateway"]
    Router --> Controller["Controller"]
    Gateway --> Handler["Handler"]
    Controller --> Handler

For a deeper composition view, see Component Interactions.

In This Section¶

• Routes - Gateway, Include, and route organization
• Handlers - HTTP method decorators (@get, @post, etc.)
• Router - Router configuration and ChildRavyn
• Controllers - Class-based route handlers
• Webhooks - Webhook endpoints

Quick Links¶

Getting Started¶

• Create your first route
• Use HTTP handlers
• Organize with Include

Common Tasks¶

• Define GET/POST endpoints
• Group routes
• Handle WebSockets
• Create controllers

Advanced Topics¶

• ChildRavyn applications
• Route parameters
• Webhook handling

Recommended order¶

1. Routes
2. Handlers
3. Router
4. Controllers
5. Webhooks

Related sections¶

• Application
• Permissions
• Security