Django Rest Framework Документация вложенный Serializer - PullRequest
Новая
       33

Django Rest Framework Документация вложенный Serializer

0 голосов
/ 26 сентября 2018

Я использую модуль документации django rest framework для документирования своего API.Я сталкиваюсь с проблемой в том смысле, что вложенные сериализаторы не появляются в моей документации, а только самые внешние.В качестве примера у меня есть следующий код: 

    class MyFirstSerializer(serializers.Serializer):
        some_data = serializers.CharField(help_text="a number")
        more_data = serializers.CharField(help_text="a letter")

    class MySecondSerializer(serializers.Serializer):
        email = serializers.EmailField(help_text="the email address")
        number = serializers.CharField(help_text="a number")
        another_serializer = MyFirstSerializer(help_text='a JSON structure')

Способ работы программы - наличие вложенной структуры JSON.Однако в модулях документации упоминается тот факт, что another_serializer является полем, и он не показывает, какие данные предполагается передавать, например, как: 

    POST your/endpoint/
    Parameter           Description
    email               the email address
    number              a number
    another_serializer  a JSON structure

Я хотел бы найти способ для документациибыть выполненным рекурсивно на всех моих полях, чтобы иметь полное описание моих конечных точек, что-то вроде: 

    POST your/endpoint/
    Parameter           Description
    email               the email address
    number              a number
    another_serializer  
         some_data      a number
         more_data      a letter
...