D
Documentation
v0.1.1
FastAPI Route Documentation
Welcome to FastAPI Route documentation. FastAPI Route brings file-based routing to FastAPI.
What is FastAPI Route?
FastAPI Route is a framework that extends FastAPI with:
- File-based routing - Routes defined by folder structure
- Hot reload - Instant reload on file changes
- Build cache system - Compressed routes for faster production startup
- Middleware support - Single file for authentication, logging, rate limiting
- Auto documentation - Interactive docs at
/docs - Beautiful error pages - Syntax highlighting and line numbers
Quick Links
- Getting Started - Start here
- Installation - Install FastAPI Route
- Quick Start - Build your first API
- File-based Routing - Learn the core concept
- CLI Commands - All available commands
Features
| Feature | Description |
|---|---|
| File-based Routing | Routes from folder structure, not decorators |
| Hot Reload | Instant reload on file create/delete/edit |
| Build Cache | Compressed routes for faster startup |
| Optional Encryption | Encrypt cache for production |
| Beautiful Errors | Syntax highlighting, line numbers, suggestions |
| Auto Docs | Interactive API documentation at /docs |
| Full Config | Customizable middleware, docs, 404 pages |
| Type Safe | Full Python type hints support |
Version
Version: v0.1.0
On this page
4 sections