Генерирование пользовательского ответа для конечной точки API в Django Rest Framework с помощью drf-spectacular
Я пытаюсь сгенерировать документацию для представления на основе функций в DRF, используя библиотеку drf-spectacular.
Ответ, который я пытаюсь сгенерировать, должен выглядеть следующим образом:
Как вы видите "data" представляет собой список.
Я пытался сделать следующее:
class DocumentSerializer(serializers.Serializer):
date = serializers.IntegerField(default=123)
total_documents = serializers.IntegerField(default=1890)
@extend_schema(
parameters=[
OpenApiParameter(name='authorization', description='Authorization token', required=True, type=str, location=OpenApiParameter.HEADER),
],
description='Info about the endpoint',
responses={
200: inline_serializer(
name='Successfull response',
fields={
"result_code": serializers.IntegerField(default=200),
"result_description": serializers.CharField(default="Transaccion Exitosa"),
"data": DocumentSerializer(),
}
),
},
)
@api_view(["GET"])
def my_endpoint_function(request):
pass
Как видите, "data"
должен быть списком DocumentSerializer
, но я не знаю, как этого добиться. Результат, который я получаю с помощью приведенного выше кода, следующий:
Потому что я не знаю, как сделать так, чтобы data
имел список DocumentSerializer
.
Будет здорово, если вы сможете мне помочь, я искал в документации, но на данный момент я застрял.
Я не уверен на 100%, но добавление many=True
определенно должно создать список.
"data": DocumentSerializer(many=True)