django rest framework Viewset for single item, not list

Question

I am having a problem with my DRF API. I want to provide a read only endpoint that takes a single id from a object(document) in the DB and runs a script to perform an check and gives back the result. It works fine when I call the API with //api/documentcheck/1/ where 1 is the pk of the document in the DB. The problem is that if I just call the base URL //api/documentcheck/ it tries to give back the results of all documents in the database and times out because it takes ages.

I am looking for a way to remove the list view and force users to provide the ID for a single document to check.

This is my serializer class

class DocumentCheckSerializer(serializers.Serializer):
    '''Serializer for document check'''
 
    class Meta:
        model = Document
        fields = '__all__'
 
    def to_representation(self, value):
        return process_document(value)

This is my view:

class DocumentCheck(viewsets.ReadOnlyModelViewSet):
    """Check a single document"""
    authentication_classes = (
    TokenAuthentication,
    SessionAuthentication,
    BasicAuthentication,
    )
    permission_classes = [IsAuthenticated]
    queryset = Document.objects.all()
    serializer_class = serializers.DocumentCheckSerializer

and my router entry

router.register("documentcheck", views.DocumentCheck, basename="documentcheck")

In your viewset, you can override list and return 404

Brian Destura
– Brian Destura

2022-08-20 00:42:10 +00:00
Commented Aug 20, 2022 at 0:42 — Brian Destura
– Brian Destura, Commented Aug 20, 2022 at 0:42

Pranav Patel · Accepted Answer · 2022-08-20 11:24:14Z

1

You can use just GenericViewSet and RetrieveModelMixin as your base class

from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import RetrieveModelMixin

class DocumentCheck(GenericViewSet, RetrieveModelMixin):
    """Check a single document"""
    authentication_classes = (
    TokenAuthentication,
    SessionAuthentication,
    BasicAuthentication,
    )
    permission_classes = [IsAuthenticated]
    queryset = Document.objects.all()
    serializer_class = serializers.DocumentCheckSerializer

edited Aug 20, 2022 at 11:24

answered Aug 20, 2022 at 11:22

Pranav Patel

262 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

django rest framework Viewset for single item, not list

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related