Wrapping serializer data in a response dict

[aqeelat]

Hi,

Most of our views return the following results in the following format:

Response(
    {"result": serializer.data, 'message': 'Loaded successfully', 'status': True},
    status=200
)

What's the best way to include that in the generated schema? I was able to do it via inline_serializer, but is there a way to do it en masse? Like, via a setting that says surround all returned serializers in another serializer.

[tfranzel]

Hi,

this is a special have we have dealt with before in issue #49

there is a relatively elegant workaround for these cases:

drf-spectacular/tests/test_regressions.py

Line 698 in eb02752

def enveloper(serializer_class, list):

for a global solution i would have to give it some more thought

[tfranzel]

closing this issue for now. feel free to comment if anything is missing or not working and we will follow-up.

[johnbridstrup]

I am also interested in a general solution to this. I have seen #49

[tfranzel]

This should get you pretty close. The enveloper helper is exactly the same. You just need to write a custom AutoSchema to apply this change to every response.

Remember to change DEFAULT_SCHEMA_CLASS to your CustomAutoSchema

from drf_spectacular.plumbing import get_class

def enveloper(serializer_class, many):
    component_name = 'Enveloped{}{}'.format(
        serializer_class.__name__.replace("Serializer", ""),
        "List" if many else "",
    )

    @extend_schema_serializer(many=False, component_name=component_name)
    class EnvelopeSerializer(serializers.Serializer):
        status = serializers.BooleanField()  # some arbitrary envelope field
        data = serializer_class(many=many)  # the enveloping part

    return EnvelopeSerializer

class CustomAutoSchema(AutoSchema):
    def get_response_serializers(self):
        """ use envelope on all default responses. @extend_schema will override this change """
        serializer_class = get_class(self._get_serializer())
        return enveloper(
            serializer_class=serializer_class,
            many=self._is_list_view(serializer_class)
        )

[johnbridstrup]

Thank you! Very helpful A+

[shalushaji]

@tfranzel The enveloper works properly. But it is missing the paginated response. Outer fields are properly shown, but the paginated answer is missing. May be because of explicitly mentioned the serializer_class in the EnvelopeSerializer.

Respose i need

{
  "status": true,
  "detail": "Success",
  "code": 200,
  "data": {
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
      {
        "id": "string",
        "code": "string",
        "address": "string",
        "latitude": 90,
        "longitude": 180,
        "created_on": "2024-04-18T06:40:27.086Z"
      }
    ]
  }
}

Response i getting

{
  "status": true,
  "detail": "Success",
  "code": 200,
  "data": [
    {
      "id": "string",
      "code": "string",
      "address": "string",
      "latitude": 90,
      "longitude": 180,
      "created_on": "2024-04-18T07:04:23.118Z"
    }
  ]
}