Personnalisation de la réponse de retour de l'ensemble de requêtes

La réponse à cela dépend du type de vue que vous utilisez, mais l'essentiel est que vous ne le faites pas dans get_queryset , vous le faites dans la méthode du type de demande.

Par exemple, si vous utilisez un RetrieveAPIView a> vous devez remplacer la méthode retrieve de RetrieveModelMixin comme ceci:

class MyAPIView(RetrieveAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MySerializer

    def retrieve(self, request, *args, **kwargs):
        instance = self.get_object()
        serializer = self.get_serializer(instance)
        data = {
            "collection": {
                "data": serializer.data
            },
            "statusCode": 200,
            "version": "1.0"
        }
        return Response(data)

Si vous utilisez autre chose comme un ListAPIView, vous voulez voir ce qui est utilisé par cela dans le et remplacez-la pour envelopper vos données.

La chose principale à réaliser ici est que cela n'a rien à voir avec l'obtention du jeu de requêtes - qui consiste simplement à obtenir des données de la base de données. Il s'agit de transformer les données dans le format correct lors du renvoi d'une réponse. En conséquence, le travail doit être effectué au moment où la réponse est faite.

Il existe deux solutions possibles à ce problème. NDevox mentionne déjà comment nous pouvons écraser notre fonction retrive et obtenir notre réponse attendue. Mais si nous voulons que cela soit fait avec chaque réponse pour chaque point de terminaison api et si nous procédons de cette façon, nous devons écraser chaque fonction, alors son lourd fardeau et son DRY nous devons éviter cela autant que possible. Un des moyens possibles d'introduire un middleware ou d'écraser la Réponse afin que nous puissions obtenir notre réponse générique pour chaque point de terminaison api sans écraser explicitement chaque fonctionnalité.

Solution possible une

Comme nous utilisons DRF ici, nous pouvons ajouter nos propres réponses de retour avec différents types de médias, par exemple pour application / json .

Nous devons d'abord ajouter dans nos settings.py

from collections import OrderedDict

class OurParentViewset(serializer.ModelSerializer):

    ......
    def to_representation(self, instance):
        data = super(serializers.ModelSerializer, self).to_representation(instance)
        result = OrderedDict()
        result['data'] = data
        result['version'] = '1.0'
        result['statusCode'] = '2xx' # i am not fully sure how to customize this
        return result

    class A(OurParentViewset):
        ........

    class B(OurParentViewset):
        ........


    class C(OurParentViewset):
        ........

Et dans notre middleware de rendu personnalisé

class A(serializer.ModelSerializer):
    ........

class B(serializer.ModelSerializer):
    ........


class C(serializer.ModelSerializer):
    ........

Référence Lien

Possible Solution Deux

Si nous utilisons ModelViewset , il existe un autre moyen d'y parvenir. Dites que nos vues.py sont comme suit

from rest_framework.renderers import BaseRenderer
from rest_framework.utils import json


class ApiRenderer(BaseRenderer):

    def render(self, data, accepted_media_type=None, renderer_context=None):
        our_response_dict = {
            'version': '1.0'
            'data': {},
            'message': '',
        }
        if data.get('data'):
            our_response_dict['data'] = data.get('data')
        if data.get('status'):
            our_response_dict['statusCode'] = data.get('status')
        if data.get('message'):
            our_response_dict['message'] = data.get('message')
        data = our_response_dict
        return json.dumps(data)

Notre objectif est d'écraser la fonction to_representation de ModelViewset et de renvoyer notre résultat personnalisé. Ce sera comme suit

REST_FRAMEWORK = {
    ...
    'DEFAULT_RENDERER_CLASSES': (
        'app_name.renderers.ApiRenderer',  # our own render middleware
    ),
    ...
}