fastapi-sdk 0.2.1

Utilities for FastAPI projects.

FastAPI SDK

A powerful SDK for building FastAPI applications with built-in authentication, authorization, and CRUD operations.

Features

• 🔐 Authentication & Authorization

  • JWT-based authentication
  • Role-based access control
  • Fine-grained permissions
  • User claims management

• 🗄️ Database Operations

  • Automatic CRUD operations
  • Soft delete support
  • Pagination
  • Relationship handling

• 🛡️ Security

  • Ownership-based access control
  • Permission-based authorization
  • Role-based access control
  • Secure token handling

• 📝 Type Safety

  • Pydantic model integration
  • Type hints throughout
  • Automatic validation
  • OpenAPI documentation

Documentation

• Route Controller Documentation - Learn how to create CRUD routes with authentication and permissions
• Model Controller Documentation - Understand how to implement database operations and relationships

Installation

pip install fastapi-sdk

Quick Start

from fastapi import FastAPI
from fastapi_sdk.controllers.route import RouteController
from fastapi_sdk.middleware.auth import AuthMiddleware

app = FastAPI()

# Add authentication middleware
app.add_middleware(
    AuthMiddleware,
    public_routes=["/docs", "/openapi.json"],  # Routes that don't require authentication
    auth_issuer="https://your-auth-server.com",  # The issuer of the JWT tokens
    auth_client_id="your-client-id",  # Your application's client ID
    env="prod",  # Environment: "test" or "prod"
    # Optional: Test environment keys
    test_private_key_path="path/to/private.key",  # Only needed for test environment
    test_public_key_path="path/to/public.key",  # Only needed for test environment
)

# Create a route controller
account_routes = RouteController(
    prefix="/accounts",
    tags=["accounts"],
    controller=AccountController,
    get_db=get_db,
    schema_response=AccountResponse,
    schema_response_paginated=BaseResponsePaginated[AccountResponse],
    schema_create=AccountCreate,
    schema_update=AccountUpdate,
)

# Include routes
app.include_router(account_routes.router)

Development

Setup

1. Clone the repository
2. Install dependencies:

uv sync

Running Tests

pytest

License

MIT License - see LICENSE file for details