How to set up Redis caching with FastAPI using fastapi-plugins?

Install the package, configure RedisSettings in your AppSettings class, and initialize the redis_plugin in the lifespan function, as shown in the quick start example. This integrates Redis for caching with minimal code.

Can fastapi-plugins handle background jobs like Celery?

It provides basic async job scheduling using aiojobs, but for advanced features like distributed task queues or complex workflows, Celery might be better. The README notes Celery integration is still in progress, indicating limitations.

What are the differences between fastapi-plugins and other FastAPI middleware libraries?

fastapi-plugins focuses on a plugin-based architecture for utilities like caching and scheduling, offering modularity but with more boilerplate. Alternatives might provide lighter-weight or more specialized solutions for specific needs.

How to configure logging with JSON output in fastapi-plugins?

Set the logging_style to LoggingStyle.logjson in your AppSettings class, and the log_plugin will automatically handle JSON-formatted logs integrated into the FastAPI lifecycle, as described in the logging documentation.

Does fastapi-plugins support Memcached for caching?

Yes, it supports Memcached by installing the 'memcached' extra and using MemcachedSettings with the memcached_plugin, demonstrated in the code examples for caching operations.

Is fastapi-plugins compatible with FastAPI's dependency injection system?

Yes, plugins can be injected as dependencies in route functions using types like TRedisPlugin, allowing easy access to utilities within endpoints without manual instantiation, as shown in the root_get example.

Open-Awesome

FastAPI Plugins

MITPython0.14.0

A collection of reusable plugins for FastAPI to add caching, scheduling, logging, and configuration management with minimal effort.

GitHub

608 stars28 forks0 contributors

What is FastAPI Plugins?

FastAPI-plugins is a collection of modular plugins for the FastAPI framework that provides common utilities like caching, task scheduling, logging, and application control. It enables developers to integrate these features with minimal configuration, reducing boilerplate and promoting code reuse for building production-ready APIs.

Target Audience

FastAPI developers building scalable, production-ready web APIs who need integrated utilities like caching, background job scheduling, and structured logging without extensive custom implementation.

Value Proposition

Developers choose fastapi-plugins for its plugin-based architecture that simplifies adding complex functionalities with minimal effort, supporting Redis, Memcached, async scheduling, and health checks out of the box, all while maintaining FastAPI's high performance and ease of use.

Overview

FastAPI framework plugins

Use Cases

Best For

Adding Redis or Memcached caching to FastAPI applications with minimal setup
Implementing async job scheduling for background task management in FastAPI
Integrating production-ready health checks, versioning, and environment monitoring endpoints
Centralizing configuration management with structured settings in FastAPI projects
Setting up configurable logging with JSON output integrated into the FastAPI lifecycle
Building modular FastAPI applications where utilities can be plugged in and reused across services

Not Ideal For

Applications that only require simple in-memory caching without Redis or Memcached dependencies
Projects built on other async web frameworks like Quart or Sanic, where FastAPI-specific plugins are not compatible
Teams needing advanced background job processing with features like task queues, retries, and monitoring beyond basic async scheduling

Pros & Cons

Pros

Comprehensive Caching Support

Supports both Redis and Memcached for efficient data storage, with clear documentation and installation extras for each, as outlined in the cache and quick start sections.

Integrated Async Scheduling

Uses aiojobs for background task management, seamlessly integrated into FastAPI's lifespan events for proper initialization and cleanup, demonstrated in the scheduler plugin example.

Production Control Endpoints

Includes health checks, versioning, environment monitoring, and heartbeat endpoints out of the box, essential for API observability in production environments.

Structured Configuration

Provides a centralized settings class that can be extended, reducing configuration boilerplate and promoting consistency across applications, as shown in the AppSettings example.

Cons

Verbose Initialization

Requires manual setup of each plugin in the lifespan function with separate init and terminate calls, leading to repetitive boilerplate code, as evident in the quick start example.

External Service Dependencies

Caching features depend on Redis or Memcached, adding infrastructure complexity and operational overhead for deployment and maintenance.

Incomplete Documentation

The README has placeholder text like 'Add information about plugin system,' indicating gaps in documentation that could hinder quick adoption and troubleshooting.

Frequently Asked Questions

Related Projects

Strawberry GraphQL

A GraphQL library for Python that leverages type annotations 🍓

Stars4,713

Forks660

Last commit13 hours ago

FastAPI Utilities

Reusable utilities for FastAPI

Stars2,308

Forks189

Last commit1 year ago

SlowApi

A rate limiter for Starlette and FastAPI

Stars2,056

Forks130

Last commit12 hours ago

FastAPI Cache

fastapi-cache is a tool to cache fastapi response and function result, with backends support redis and memcached.

Stars1,867

Forks206