How can I register a single view (not a viewset) on my router?

by

Routers work with a ViewSet and aren’t designed for normal views, but that doesn’t mean that you cannot use them with a normal view. Normally they are used with models (and a ModelViewSet), but they can be used without them using the GenericViewSet (if you would normally use a GenericAPIView) and ViewSet (if you would just use an APIView).

For a list view, the request methods are mapped to ViewSet methods like this

  • GET -> list(self, request, format=None)
  • POST– > create(self, request, format=None)

For detail views (with a primary key in the url), the request methods use the following map

  • GET -> retrieve(self, request, pk, format=None)
  • PUT -> update(self, request, pk, format=None)
  • PATCH -> partial_update(self, request, pk, format=None)
  • DELETE -> destroy(self, request, pk, format=None)

So if you want to use any of these request methods with your view on your router, you need to override the correct view method (so list() instead of get()).

Now, specifically in your case you would have normally use an APIView that looked like

class UpdateTimeView(APIView):

    def get(self, request, format=None):
        latest_publish = Publish.objects.latest('created_time')
        latest_meeting = Meeting.objects.latest('created_time')
        latest_training = Training.objects.latest('created_time')
        latest_exhibiting = Exhibiting.objects.latest('created_time')

        return Response({
            "publish_updatetime": latest_publish.created_time,
            "meeting_updatetime": latest_meeting.created_time,
            "training_updatetime": latest_training.created_time,
            "exhibiting_updatetime": latest_exhibiting.created_time,
        })

The comparable ViewSet would be

class UpdateTimeViewSet(ViewSet):

    def list(self, request, format=None):
        latest_publish = Publish.objects.latest('created_time')
        latest_meeting = Meeting.objects.latest('created_time')
        latest_training = Training.objects.latest('created_time')
        latest_exhibiting = Exhibiting.objects.latest('created_time')

        return Response({
            "publish_updatetime": latest_publish.created_time,
            "meeting_updatetime": latest_meeting.created_time,
            "training_updatetime": latest_training.created_time,
            "exhibiting_updatetime": latest_exhibiting.created_time,
        })

Notice the two required changes: APIView -> ViewSet and get -> list. I also updated the name to indicate that it was more than just a normal view (as a ViewSet cannot be initialized the same way), but that’s not required.

So with this new view, you can just register it in the router the same way as any other. You need a base_name here so the url names can be generated (normally this would pull from the queryset).

router.register(r'updatetime', views.UpdateTimeViewSet, base_name="updatetime")

So now the updatetime endpoint will be made available in the API root and you can get the latest times by just calling the endpoint (a simple GET request).

More Related Contents:

  1. Does the django-rest-framework provide an admin site to manage models?
  2. How can I enable CORS on Django REST Framework
  3. DRF: Simple foreign key assignment with nested serializers?
  4. Django Rest Framework File Upload
  5. How do I include related model fields using Django Rest Framework?
  6. Include intermediary (through model) in responses in Django Rest Framework
  7. Retrieving a Foreign Key value with django-rest-framework serializers
  8. Django REST Framework upload image: “The submitted data was not a file”
  9. Django rest framework serializing many to many field
  10. Django serializer Imagefield to get full URL
  11. django-rest-framework 3.0 create or update in nested serializer
  12. How can I use Django OAuth Toolkit with Python Social Auth?
  13. Django Rest Framework writable nested serializers
  14. Pass extra arguments to Serializer Class in Django Rest Framework
  15. Django REST: Uploading and serializing multiple images
  16. When to use Serializer’s create() and ModelViewset’s perform_create()
  17. Django Rest Framework – Authentication credentials were not provided
  18. Django REST Framework serializer field required=false
  19. Django Rest Framework – Could not resolve URL for hyperlinked relationship using view name “user-detail”
  20. Django Rest Framework – How to add custom field in ModelSerializer
  21. Order of Serializer Validation in Django REST Framework
  22. Django Python rest framework, No ‘Access-Control-Allow-Origin’ header is present on the requested resource in chrome, works in firefox
  23. how to add annotate data in django-rest-framework queryset responses?
  24. Django viewset has not attribute ‘get_extra_actions’
  25. How to use csrf_token in Django RESTful API and React?
  26. How to upload multiple files in django rest framework
  27. Django: app level variables
  28. How to add custom field in ModelSerializer?
  29. CSRF validation does not work on Django using HTTPS
  30. Multiple lookup_fields for django rest framework

Leave a Comment