fastapi-views 0.3.1

FastAPI Class Views and utilities

fastapi-views

FastAPI Class Views and utilities

---

Version: 0.3.1

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

Repository: https://github.com/asynq-io/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