Getting Started

FastAPI Route introduces file-based routing to FastAPI. Instead of writing decorators for every endpoint, you just create files and folders.

Quick Overview

FastAPI Route converts your file structure into API routes automatically:

• routes/index.py → GET /, POST /
• routes/users/route.py → GET /users, POST /users
• routes/users/[user_id]/route.py → GET /users/{user_id}

Key Features

• File-based Routing - Routes defined by folder structure, no decorators needed
• Hot Reload - Instant reload on any file change
• Build Cache System - Production build with compression for faster startup
• Middleware Support - Single file for authentication, logging, rate limiting
• Auto Documentation - Interactive docs at /docs with all routes
• Beautiful Error Pages - Syntax highlighting and line numbers for debugging

Requirements

• Python 3.8 or higher
• FastAPI (auto-installed with FastAPI Route)

Next Steps

• Installation - Install FastAPI Route
• Quick Start - Build your first API
• Project Structure - Understand the folder layout