fastapi-conventions

What problem does it solve?

Streamline the architecture of FastAPI projects by enforcing modular design, per-feature routers, and reusable dependencies to improve maintainability and scalability.

Core Features & Use Cases

• APIRouter per feature module: Group related endpoints under a shared prefix and tags, reducing repetition and improving navigation.
• Factory pattern with lifespan management: Use a create_app() factory with an async lifespan for startup/shutdown coordination.
• Pydantic v2 schemas & validation: Leverage model_config and validators for robust data models and ORM integration.
• Dependency injection & security: Build reusable dependencies (e.g., get_db, get_current_user) and compose them across routes.
• OpenAPI customization & environment config: Centralize app settings via pydantic-settings and tailor OpenAPI output.

Quick Start

Create a FastAPI app using a create_app() factory, wire feature routers, and configure dependencies through environment settings.