Skip to main content

FastAPI Class Views and utilities

Project description

fastapi-views

CI Build License Python Format PyPi Mypy Code Style security: bandit

FastAPI Class Views and utilities


Version: 0.3.0

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

Repository: https://github.com/performancemedia/fastapi-views


Installation

pip install fastapi-views

Usage

from typing import Optional
from uuid import UUID

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


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


items = {}


class MyViewSet(AsyncAPIViewSet):
    api_component_name = "Item"
    serializer = ItemSchema
    
    async def list(self):
        return list(items.values())

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

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

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

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

router = ViewRouter(prefix="/items")
router.register_view(MyViewSet)
# in app.py
# app.include_router(router)

Features

  • Class Based Views
    • APIViews
    • GenericViews
    • ViewSets
  • Both async and sync function support
  • No dependencies on ORM
  • Openapi id simplification
  • 'Smart' and fast serialization using orjson
  • Http Problem Details implementation
  • Automatic prometheus metrics exporter
  • Pluggable healthcheck helper

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-0.3.0.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

fastapi_views-0.3.0-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_views-0.3.0.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for fastapi_views-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3710802691d8802f2ba896a8b40025c9de4e8584dc882bc7b2ba81d0ee98142c
MD5 671c082f2deb4e4bc45d267fd1add96f
BLAKE2b-256 58b06fca14323136a32d50e77ceea0bc06c43b90e54bc2c553885202ee11b04d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_views-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0ec612d42a68738101e822e97b3399443a21d20f905cfd4ca9f4d3c2f5aa194
MD5 f5a600605a36aacd9defcacb7de7c06c
BLAKE2b-256 ebe8af4f19eda1d1b2915f4326173059f6d029ffebce9a843ccfacd344b9bdd2

See more details on using hashes here.

Supported by

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