Fastapi Snippets

🚀 Ultimate FastAPI Snippets for Zed

Supercharge your FastAPI development in the Zed code editor with this collection of production-ready code snippets. From bootstrapping your app to deploying with FastAPI Cloud and fastapi deploy, these snippets follow modern best practices and save you time.

✨ Features

• FastAPI Cloud & CLI Ready: Full support for fastapi dev, fastapi run, and fastapi deploy patterns.
• Modern Lifespan Handlers: Uses @asynccontextmanager lifespans instead of deprecated @app.on_event startup/shutdown handlers.
• Modern Syntax: Uses modern Python features like Annotated for clear, type-safe code.
• Pydantic v2 Ready: Snippets utilize Pydantic v2 conventions like model_config and model_dump().
• Asynchronous by Default: Prioritizes async patterns for high-performance applications.
• Comprehensive: Covers basic app setup, security, database models, WebSockets, caching, health probes, and cloud deployments.

⚡ New in this Version

This version introduces dedicated support for FastAPI Cloud, the official FastAPI CLI, and modern lifespan lifecycle management:

• fastcloudapp: Creates a production-ready FastAPI app instance configured for FastAPI Cloud & CLI with lifespan and CORS.
• fastlifespan: Sets up an @asynccontextmanager lifespan context manager for startup and shutdown event management.
• fastcloudhealth: Implements standardized /healthz (liveness) and /readyz (readiness) probe endpoints for zero-downtime cloud deployments.
• fastcloudsettings: Pydantic Settings configured for cloud environments and secret management.
• Modernized Existing Snippets: Refactored fastasyncdb and fastcache to use modern lifespan handlers, and updated fastcrud to Pydantic v2 model_dump().

Example: fastcloudapp

Quickly create a cloud-ready app instance with lifespan:

from contextlib import asynccontextmanager
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware

@asynccontextmanager
async def lifespan(app: FastAPI):
    # Startup tasks (e.g. connect DB, warmup caches)
    yield
    # Teardown tasks (e.g. close connections)

app = FastAPI(
    title="FastAPI Cloud App",
    description="Production-ready FastAPI app for FastAPI Cloud & CLI.",
    version="0.1.0",
    lifespan=lifespan,
    docs_url="/docs",
    redoc_url="/redoc",
)

app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

Example: fastcloudhealth

Add zero-downtime liveness and readiness probes:

from fastapi import APIRouter, status

router = APIRouter(tags=["Monitoring"])

@router.get("/healthz", status_code=status.HTTP_200_OK, include_in_schema=False)
async def liveness():
    """Liveness probe to verify the application process is up."""
    return {"status": "healthy"}

@router.get("/readyz", status_code=status.HTTP_200_OK, include_in_schema=False)
async def readiness():
    """Readiness probe to verify external dependencies (e.g. DB, cache) are healthy."""
    return {"status": "ready"}

📚 Full Snippet Reference

Here is a complete list of all available snippets.

🤝 Contributing

Contributions are welcome! If you have a snippet that you think would be a great addition, please feel free to open a pull request.

1. Fork the repository.
2. Create a new branch (git checkout -b feature/my-new-snippet).
3. Add your snippet to snippets/python.json.
4. Update this README file to include your new snippet.
5. Open a pull request with a clear description of your changes.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

---