Skip to main content

FastAPI Class Views and utilities

Project description

fastapi-views

Tests Build License Mypy Ruff Pydantic v2 security: bandit Python Format PyPi

Class-based views, CRUD utilities, and production-ready patterns for FastAPI.

FastAPI Views brings Django REST Framework-style class-based views to FastAPI — without giving up type safety or dependency injection. Define a full CRUD resource by inheriting one class; routes, status codes, and OpenAPI docs are wired up automatically.

Features

  • Class-based viewsView, APIView, ViewSet, and GenericViewSet at three levels of abstraction; mix-in only the actions you need
  • Full CRUD in one classlist, create, retrieve, update, partial_update, destroy with correct HTTP semantics out of the box (201 Created, 204 No Content, Location header, etc.)
  • Generic views with the repository pattern — plug in any data source (SQLAlchemy, Motor, plain dicts) via a simple protocol; no ORM dependency
  • DRF-style filtersModelFilter, OrderingFilter, SearchFilter, PaginationFilter, TokenPaginationFilter, FieldsFilter, and a combined Filter class; built-in SQLAlchemy and Python object resolvers
  • RFC 9457 Problem Details — every error response is machine-readable; built-in classes for the most common cases; custom errors auto-register in the OpenAPI spec
  • Fast Pydantic v2 serializationTypeAdapter cached per schema type avoids the double validation/model instantiation that FastAPI does by default, reducing per-request overhead
  • Server-Sent EventsServerSideEventsAPIView and @sse_route handle framing, content-type, and Pydantic validation automatically
  • Async and sync support — every class ships an Async and a synchronous variant; sync endpoints run in a thread pool
  • One-call setupconfigure_app(app) registers error handlers, Prometheus middleware, and OpenTelemetry instrumentation
  • Prometheus metrics/metrics endpoint with request count, latency histogram, and in-flight requests (optional extra)
  • OpenTelemetry tracingcorrelation_id injected into every error response for easy trace correlation (optional extra)
  • Readable OpenAPI operation IDslist_item, create_item, retrieve_item instead of FastAPI's long path-derived defaults
  • CLI — export a static openapi.json / openapi.yaml without starting a server

Documentation: https://asynq-io.github.io/fastapi-views/

Repository: https://github.com/asynq-io/fastapi-views


Installation

pip install fastapi-views

Optional dependencies

Avaliable extensions: uvloop, prometheus, uvicorn, opentelemetry, cli

pip install 'fastapi-views[all]'

Quick start

from typing import ClassVar, Optional
from uuid import UUID

from fastapi import FastAPI
from pydantic import BaseModel

from fastapi_views import ViewRouter, configure_app
from fastapi_views.views.viewsets import AsyncAPIViewSet


class ItemSchema(BaseModel):
    id: UUID
    name: str
    price: int


class ItemViewSet(AsyncAPIViewSet):
    api_component_name = "Item"
    response_schema = ItemSchema

    # In-memory store — swap for a real repository in production
    items: ClassVar[dict[UUID, ItemSchema]] = {}

    async def list(self) -> list[ItemSchema]:
        return list(self.items.values())

    async def create(self, item: ItemSchema) -> ItemSchema:
        self.items[item.id] = item
        return item

    async def retrieve(self, id: UUID) -> Optional[ItemSchema]:
        return self.items.get(id)

    async def update(self, id: UUID, item: ItemSchema) -> ItemSchema:
        self.items[id] = item
        return item

    async def destroy(self, id: UUID) -> None:
        self.items.pop(id, None)


router = ViewRouter(prefix="/items")
router.register_view(ItemViewSet)

app = FastAPI(title="My API")
app.include_router(router)

configure_app(app)

This registers the following routes automatically:

Method Path Action Status code
GET /items list 200
POST /items create 201
GET /items/{id} retrieve 200
PUT /items/{id} update 200
DELETE /items/{id} destroy 204

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_views-1.6.1.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_views-1.6.1-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_views-1.6.1.tar.gz.

File metadata

  • Download URL: fastapi_views-1.6.1.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for fastapi_views-1.6.1.tar.gz
Algorithm Hash digest
SHA256 34ddc7b6cac96945b53b59545adf7087f8f31f7dd1878ab2270ff308a680a247
MD5 c1ab760732e69ae66b6033f7661ac518
BLAKE2b-256 02399f5d87b56dda0312b8aea4dd0140ad77d743b4377544ac6ba018de6fce91

See more details on using hashes here.

File details

Details for the file fastapi_views-1.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_views-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 874ec5538aa28d773e38af3ef547480306f085470eb67201946c7dd1ab1d1ca9
MD5 4f0ae1496b1338138b06bbe82969a327
BLAKE2b-256 670724c629c75c6da62b86a5a17affaa3ac35a3b2cb56634271748006fe47c04

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page