Tutorial¶

Welcome to the REROUTE tutorial! This progressive learning path takes you from beginner to advanced, with hands-on examples at every step.

Tutorial Structure¶

The tutorial is organized by difficulty level:

Very Easy (5-10 minutes each)¶

Perfect for complete beginners. Get your first API running quickly.

Hello World - Your first API in 5 minutes
First Server - Running the development server
Understanding Routes - How file-based routing works

Easy (15-20 minutes each)¶

Build on the basics with common API patterns.

Dynamic Routes - Working with path parameters
HTTP Methods - GET, POST, PUT, DELETE
Query Parameters - Request query strings

Medium (30-45 minutes each)¶

Real-world applications with more complexity.

CRUD Application - Full Create, Read, Update, Delete
Decorators Intro - Rate limiting, caching, validation
Error Handling - Custom error responses

Hard (45-60 minutes each)¶

Advanced features for production applications.

Coming soon: - Authentication - JWT tokens and API keys - Database Integration - SQLAlchemy models - WebSockets - Real-time communication

Difficult (60+ minutes each)¶

Production-ready implementations.

Coming soon: - Production Deployment - Docker, cloud hosting - Performance Optimization - Caching strategies - Security Hardening - OWASP compliance

How to Use This Tutorial¶

Progressive Learning¶

Each tutorial builds on previous ones. We recommend starting at the beginning and working through sequentially.

Hands-On Approach¶

Every tutorial includes: - Working code examples you can copy and run - Expected output so you know if it's working - Troubleshooting sections for common issues - "Next steps" to continue your learning

Difficulty Indicators¶

Each tutorial page shows: - Difficulty: Very Easy | Easy | Medium | Hard | Difficult - Time: Estimated completion time - Prerequisites: What you need to know first - Next: What to learn after this tutorial

Before You Start¶

Prerequisites¶

Python 3.8 or higher
Basic Python knowledge (functions, classes)
Text editor or IDE (VS Code, PyCharm, etc.)
Command line/terminal basics

Installation¶

If you haven't installed REROUTE yet:

pip install reroute[fastapi]

Or with uv (faster):

uv pip install reroute[fastapi]

Need help? See Installation Troubleshooting.

Verification¶

Check your installation:

python -c "import reroute; print(reroute.__version__)"

You should see version information printed.

Your First Tutorial¶

Ready to start? Jump into Hello World and build your first REROUTE API in 5 minutes!

Learning Path Summary¶

Start Here → Very Easy → Easy → Medium → Hard → Difficult
   ↓            ↓          ↓        ↓        ↓         ↓
Quiz       Hello World  Dynamic   CRUD    Auth    Production
           First Server Routes           WebSockets   Docker
           File Routes HTTP Methods     Database     Security

Each step builds on the previous, so you'll always be building on solid foundations.

Need Help?¶

Stuck on installation? Installation Troubleshooting
General issues? Troubleshooting Guide
Want to ask questions? GitHub Discussions

Let's Get Started!¶

Choose your starting point:

Complete Beginner → Start with Hello World
Some Experience → Jump to Dynamic Routes
Know the Basics → Go to CRUD Application
Production Ready → Explore the Guides section

Happy coding!