Skip to content

ViewSets

Pre-built combinations of the individual *APIView mixin classes. Import from fastapi_views.views.viewsets.

Each ViewSet bundles a fixed set of CRUD actions. Use AsyncAPIViewSet for the full five-action set, or pick a smaller combination (e.g., AsyncReadOnlyAPIViewSet, AsyncListCreateAPIViewSet) to expose only what your resource needs.

For a complete walkthrough see ViewSets.

ReadOnlyAPIViewSet

Bases: ListAPIView, RetrieveAPIView, ABC

ReadOnlyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
17
18
class ReadOnlyAPIViewSet(ListAPIView, RetrieveAPIView, ABC):
    """ReadOnlyAPIViewSet"""

AsyncReadOnlyAPIViewSet

Bases: AsyncListAPIView, AsyncRetrieveAPIView, ABC

AsyncReadOnlyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
21
22
class AsyncReadOnlyAPIViewSet(AsyncListAPIView, AsyncRetrieveAPIView, ABC):
    """AsyncReadOnlyAPIViewSet"""

ListCreateAPIViewSet

Bases: ListAPIView, CreateAPIView, ABC

ListCreateAPIViewSet

Source code in fastapi_views/views/viewsets.py 
25
26
class ListCreateAPIViewSet(ListAPIView, CreateAPIView, ABC):
    """ListCreateAPIViewSet"""

AsyncListCreateAPIViewSet

Bases: AsyncListAPIView, AsyncCreateAPIView, ABC

AsyncListCreateAPIViewSet

Source code in fastapi_views/views/viewsets.py 
29
30
class AsyncListCreateAPIViewSet(AsyncListAPIView, AsyncCreateAPIView, ABC):
    """AsyncListCreateAPIViewSet"""

RetrieveUpdateAPIViewSet

Bases: RetrieveAPIView, UpdateAPIView, ABC

RetrieveUpdateAPIViewSet

Source code in fastapi_views/views/viewsets.py 
33
34
class RetrieveUpdateAPIViewSet(RetrieveAPIView, UpdateAPIView, ABC):
    """RetrieveUpdateAPIViewSet"""

AsyncRetrieveUpdateAPIViewSet

Bases: AsyncRetrieveAPIView, AsyncUpdateAPIView, ABC

AsyncRetrieveUpdateAPIViewSet

Source code in fastapi_views/views/viewsets.py 
37
38
class AsyncRetrieveUpdateAPIViewSet(AsyncRetrieveAPIView, AsyncUpdateAPIView, ABC):
    """AsyncRetrieveUpdateAPIViewSet"""

RetrieveUpdateDestroyAPIViewSet

Bases: RetrieveAPIView, UpdateAPIView, DestroyAPIView, ABC

RetrieveUpdateDestroyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
41
42
43
44
45
46
47
class RetrieveUpdateDestroyAPIViewSet(
    RetrieveAPIView,
    UpdateAPIView,
    DestroyAPIView,
    ABC,
):
    """RetrieveUpdateDestroyAPIViewSet"""

AsyncRetrieveUpdateDestroyAPIViewSet

Bases: AsyncRetrieveAPIView, AsyncUpdateAPIView, AsyncDestroyAPIView, ABC

AsyncRetrieveUpdateDestroyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
50
51
52
53
54
55
56
class AsyncRetrieveUpdateDestroyAPIViewSet(
    AsyncRetrieveAPIView,
    AsyncUpdateAPIView,
    AsyncDestroyAPIView,
    ABC,
):
    """AsyncRetrieveUpdateDestroyAPIViewSet"""

ListRetrieveUpdateDestroyAPIViewSet

Bases: ListAPIView, RetrieveAPIView, UpdateAPIView, DestroyAPIView, ABC

ListRetrieveUpdateDestroyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
59
60
61
62
63
64
65
66
class ListRetrieveUpdateDestroyAPIViewSet(
    ListAPIView,
    RetrieveAPIView,
    UpdateAPIView,
    DestroyAPIView,
    ABC,
):
    """ListRetrieveUpdateDestroyAPIViewSet"""

AsyncListRetrieveUpdateDestroyAPIViewSet

Bases: AsyncListAPIView, AsyncRetrieveAPIView, AsyncUpdateAPIView, AsyncDestroyAPIView, ABC

AsyncListRetrieveUpdateDestroyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
69
70
71
72
73
74
75
76
class AsyncListRetrieveUpdateDestroyAPIViewSet(
    AsyncListAPIView,
    AsyncRetrieveAPIView,
    AsyncUpdateAPIView,
    AsyncDestroyAPIView,
    ABC,
):
    """AsyncListRetrieveUpdateDestroyAPIViewSet"""

ListCreateDestroyAPIViewSet

Bases: ListAPIView, CreateAPIView, DestroyAPIView, ABC

ListCreateDestroyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
79
80
class ListCreateDestroyAPIViewSet(ListAPIView, CreateAPIView, DestroyAPIView, ABC):
    """ListCreateDestroyAPIViewSet"""

AsyncListCreateDestroyAPIViewSet

Bases: AsyncListAPIView, AsyncCreateAPIView, AsyncDestroyAPIView, ABC

AsyncListCreateDestroyAPIViewSet

Source code in fastapi_views/views/viewsets.py 
83
84
85
86
87
88
89
class AsyncListCreateDestroyAPIViewSet(
    AsyncListAPIView,
    AsyncCreateAPIView,
    AsyncDestroyAPIView,
    ABC,
):
    """AsyncListCreateDestroyAPIViewSet"""

APIViewSet

Bases: ListAPIView, CreateAPIView, RetrieveAPIView, UpdateAPIView, DestroyAPIView, ABC

APIViewSet

Source code in fastapi_views/views/viewsets.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
class APIViewSet(
    ListAPIView,
    CreateAPIView,
    RetrieveAPIView,
    UpdateAPIView,
    DestroyAPIView,
    ABC,
):
    """APIViewSet"""

AsyncAPIViewSet

Bases: AsyncListAPIView, AsyncCreateAPIView, AsyncRetrieveAPIView, AsyncUpdateAPIView, AsyncDestroyAPIView, ABC

AsyncAPIViewSet

Source code in fastapi_views/views/viewsets.py 
103
104
105
106
107
108
109
110
111
class AsyncAPIViewSet(
    AsyncListAPIView,
    AsyncCreateAPIView,
    AsyncRetrieveAPIView,
    AsyncUpdateAPIView,
    AsyncDestroyAPIView,
    ABC,
):
    """AsyncAPIViewSet"""