Developing Asynchronous Web Applications with FastAPI

{
  "title": "Developing Asynchronous Web Applications with FastAPI",
  "description": "Best practices for building high-performance, asynchronous web applications using FastAPI, including code structuring and concurrency management.",
  "category": "Python Cursor Rules",
  "rules": [
    {
      "id": "fastapi-async-structure",
      "name": "Modular Project Structure",
      "description": "Organize FastAPI projects into modular components to enhance maintainability and scalability.",
      "recommendation": "Structure your project with directories such as 'models' for database schemas, 'api' for route definitions, 'services' for business logic, 'core' for utilities, and 'db' for database connections.",
      "severity": "info"
    },
    {
      "id": "fastapi-async-usage",
      "name": "Utilize Asynchronous Programming",
      "description": "Leverage FastAPI's support for asynchronous programming to improve performance, especially for I/O-bound operations.",
      "recommendation": "Define endpoints with 'async def' and use 'await' for I/O operations like database queries and HTTP requests.",
      "severity": "warning"
    },
    {
      "id": "fastapi-async-db",
      "name": "Asynchronous Database Access",
      "description": "Use asynchronous database libraries to prevent blocking the event loop during database operations.",
      "recommendation": "Employ libraries like 'asyncpg' with SQLAlchemy for non-blocking database interactions.",
      "severity": "warning"
    },
    {
      "id": "fastapi-async-bg-tasks",
      "name": "Offload Non-Critical Tasks",
      "description": "Use background tasks for operations that do not require immediate client feedback to keep endpoints responsive.",
      "recommendation": "Implement FastAPI's 'BackgroundTasks' to handle tasks like sending emails or processing data asynchronously.",
      "severity": "info"
    },
    {
      "id": "fastapi-async-blocking",
      "name": "Avoid Blocking Code",
      "description": "Ensure that synchronous, blocking code does not run in the event loop to maintain application responsiveness.",
      "recommendation": "Use 'run_in_executor' to execute blocking code in a separate thread or process.",
      "severity": "error"
    },
    {
      "id": "fastapi-async-auth",
      "name": "Implement Secure Authentication",
      "description": "Secure your API by implementing authentication and authorization mechanisms.",
      "recommendation": "Use OAuth2 with JWT tokens to manage user sessions securely.",
      "severity": "critical"
    },
    {
      "id": "fastapi-async-caching",
      "name": "Implement Caching Strategies",
      "description": "Use caching to improve response times for frequently accessed data.",
      "recommendation": "Implement in-memory caching with FastAPI or use Redis for distributed caching solutions.",
      "severity": "info"
    },
    {
      "id": "fastapi-async-testing",
      "name": "Test Asynchronous Endpoints",
      "description": "Ensure that asynchronous endpoints are properly tested to maintain application reliability.",
      "recommendation": "Use 'pytest' with 'pytest-asyncio' to write and run tests for async endpoints.",
      "severity": "warning"
    }
  ]
}