Getting Started¶

Welcome to the beginner path for Ravyn.

If this is your first time with the framework, follow this section in order. Each chapter builds on the previous one and keeps the examples practical.

Learning flow¶

first routes
  -> request/response models
  -> error handling
  -> routing structure
  -> middleware/background/dependencies
  -> full request/response handling

What you'll learn¶

• Build and run your first Ravyn API.
• Define request and response models.
• Handle validation and errors.
• Organize routes and controllers.
• Add middleware, background tasks, and dependencies.

Recommended learning order¶

1. Building Your First API
2. Request and Response Models
3. Handling Errors
4. Routing
5. Middlewares
6. Background Tasks
7. Dependencies
8. Requests and Responses
9. A bit more about Routing

Tips before you start¶

• Keep your handler return types explicit whenever possible.
• Start small: one route, one model, one concept at a time.
• Use the generated docs (/docs/swagger) while developing.

Next step¶

Start with Building Your First API.

After this track, continue with Getting Deeper into Ravyn. If you prefer one end-to-end project path, follow Build a Production API.