Drf-yasg: How to change input and return Serializer

[joseph-vedadi]

Most of my APIs input and outputs are different 👍
An example:
Input is {'A':1, 'B':2} and returns {A:{B:[1,2,3,4]}, }

The API works correctly, but the documentation page shows both the same as input (data)

How can I configure that?

[markossify95]

Just figured out the supported approach! You'll have to decorate the desired method/function with swagger_auto_schema decorator.
The usage would look something like this:

@swagger_auto_schema(responses={201: serializers.SerializerB()})
def create(self, request, *args, **kwargs):
    in_serializer = self.get_serializer(data=request.data) #this should give you a SerializerA instance
    ... # your custom business logic goes here
    out_serializer = serializers.SerializerB(data)
    return response.Response(out_serializer.data, status=201)

[axnsan12]

Yes, that is the simplest approach for this case.

A more DRY approach would be defining your own RequestResponseAPIView which would have separate request_serializer_class and response_serializer_class fields and using a custom SwaggerAutoSchema to inspect those fields, but short of doing that you're stuck manually decorating methods, since DRF by default does not distinguish request/response serializers.