What is the difference in use or inherit from APIView and Model ViewSet

Question

I would meet the difference with respect to when use APIView and when use ModelViewSet when I want serialize my models with respect to get a list of their objects/records?

For example, in the APIView documentation we have that with the ListUser class and their get method we can get the list of users

class ListUsers(APIView):
    """
    View to list all users in the system.

    * Requires token authentication.
    * Only admin users are able to access this view.
    """
    authentication_classes = (authentication.TokenAuthentication,)
    permission_classes = (permissions.IsAdminUser,)

    def get(self, request, format=None):
        """
        Return a list of all users.
        """
        usernames = [user.username for user in User.objects.all()]
        return Response(usernames)

I have been get this same list of users using ModelViewSet of this way:

class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer
    filter_fields = ('username', 'is_player', 'first_name', 'last_name', 'team' , 'email', )

How to can I identify when should I use APIView or ModelViewSet for this task?

Except for the comparision using example classes, here're the possible duplicates of this question: https://stackoverflow.com/questions/41379654/difference-between-apiview-class-and-viewsets-class and https://stackoverflow.com/questions/49482453/generics-vs-viewset-in-django-rest-framework-how-to-prefer-which-one-to-use/ — OM Bharatiya, Aug 16 '20 at 22:45

Linovia · Accepted Answer · 2017-01-26T20:19:28.463

28

Question is too open though I'll try to answer it.

First thing first, APIView or ViewSet aren't tied to models while ModelViewSet, GenericAPIView, ListAPIView (and co) are.

The major difference between *View and *ViewSet is that *ViewSet are meant to work with routers and provide a single class to expose a Resource while *View will require two (one for list/create, another for detail/update/delete).

Note that APIView is the most lower level and will only tie to HTTP verbs (get/post/put...) while ViewSet or GenericAPIView will have CRUD such as list / update...

In order to expose a Django's Model, you'll need either

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

or

class UserListCreateView(ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

class UserRetrieveUpdateDestroyView(RetrieveUpdateDestroyAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

edited Jan 26 '17 at 20:19

answered Jan 26 '17 at 17:24

Linovia

19,812
4
47
48

Thanks for the response. It's very illustrative. With `ListCreateAPIView` can I update (PUT) some model which have ManyToManyFields? – bgarcial Jan 26 '17 at 17:30
1

The view for updates should be UpdateAPIView (or UserRetrieveUpdateDestroyAPIView). I just updated my post. Note that the related fields are the domain of the serializer, not the view. – Linovia Jan 26 '17 at 20:20
I understood @Linovia, I was thinking in inheritance of `RetrieveUpdateDestroyAPIView` – bgarcial Jan 26 '17 at 20:27
2

https://stackoverflow.com/a/49489829/8454203 has beautifully explained the same. – OM Bharatiya Aug 16 '20 at 22:46

What is the difference in use or inherit from APIView and Model ViewSet

1 Answers1

Linked