FastAPI Boilerplate for Real-World Production Applications

Building a web application often involves dealing with various complexities, from managing database connections to ensuring efficient asynchronous operations. FastAPI Boilerplate addresses these challenges by providing a structured and production-ready template that simplifies the development process. This boilerplate is perfect for developers who want to leverage FastAPI's speed and performance while minimizing boilerplate code.

What Is FastAPI Boilerplate?

FastAPI Boilerplate is a comprehensive template designed to kickstart your FastAPI web applications. It incorporates essential features that are commonly required in real-world projects, allowing developers to focus on building functionality rather than setting up the infrastructure. With support for async programming and modular components, it offers a solid foundation for scalable applications.

Key Features

• Async SQLAlchemy Session: Manage database interactions efficiently with asynchronous support, improving performance and scalability.
• Custom User Class: Simplify authentication with a customizable user class that integrates seamlessly into your FastAPI application.
• Dependencies for Specific Permissions: Implement fine-grained access control using dependency injection, enhancing security.
• Celery Integration: Easily manage background tasks and asynchronous processing with built-in Celery support.
• Docker Support: Get started quickly with a Dockerized environment that allows for hot reloading during development.
• Event Dispatcher: Implement event-driven architecture with a built-in event dispatcher for better decoupling of components.
• Cache Management: Enhance performance with caching mechanisms ready to be configured for your database queries.

Installation & Setup

To get started with FastAPI Boilerplate, follow these installation steps:

docker-compose -f docker/docker-compose.yml up

poetry shell
poetry install

alembic upgrade head

python3 main.py --env local|dev|prod --debug

This will set up your environment, install dependencies, apply the necessary database migrations, and run the server in your specified environment.

How to Use It

Here’s a practical example to illustrate how you can create a user using the provided structure:

from core.db import Transactional, session

@Transactional()
async def create_user(self):
    session.add(User(email="padocon@naver.com"))

In this snippet, using the Transactional decorator automatically handles the commit for you, reducing boilerplate code and potential errors.

For querying users concurrently, you can utilize asyncio.gather() like this:

async def get_by_id(self, *, user_id) -> User:
    stmt = select(User)
    async with session_factory() as read_session:
        return await read_session.execute(stmt).scalars().first()

async def main() -> None:
    user_1, user_2 = await asyncio.gather(
        get_by_id(user_id=1),
        get_by_id(user_id=2),
    )

This allows you to efficiently fetch multiple records without blocking your application.

Who Should Use FastAPI Boilerplate?

FastAPI Boilerplate is ideal for developers looking to build high-performance web applications with minimal setup. Whether you're a seasoned developer or just starting with FastAPI, this boilerplate offers a structured approach to application development. It's particularly suited for projects that demand scalability and maintainability.

Final Thoughts

FastAPI Boilerplate stands out as a reliable starting point for anyone looking to build production-grade applications with FastAPI. Its focus on asynchronous operations, modular design, and built-in features like caching and task processing make it a powerful tool in your development arsenal. By adopting this boilerplate, you can save time and effort while ensuring that your application is set up for success from the outset. If you're ready to elevate your FastAPI projects, give FastAPI Boilerplate a try!