Показать максимум, минимум и значение по умолчанию в Swagger для Django Rest Framework

Я разрабатываю версию 2 для своего API, и я хотел бы ее должным образом задокументировать. Поскольку я использую Django Rest Framework (3.1.1), и в их документации рекомендуется использовать Swagger, я использую его.

В документации я вижу, что одна из его функций - показать «Значения поля по умолчанию, минимальные, максимальные, доступные только для чтения и обязательные атрибуты». Однако в моем примере я вижу только «Описание», «Тип параметра» и «Тип данных», как на изображении:

введите здесь описание изображения

Я хотел бы видеть больше столбцов, таких как минимум, максимум и значение по умолчанию, со значениями, взятыми из моделей (без необходимости переписывать их в сериализаторах. Это мой сериализатор, на случай, если он поможет:

class UserSerializer(serializers.ModelSerializer):

    class Meta:
        model = User
        fields = ('id', 'email', 'first_name', 'last_name', 'password',)
        write_only_fields = ('password',)
        read_only_fields = ('id',)

    def create(self, validated_data):
    [...]

Похоже, ни у кого нет такой проблемы, поэтому, возможно (надеюсь, что нет), я упускаю что-то тривиальное. Надеюсь, ты сможешь помочь. Спасибо!


python django django-rest-framework swagger swagger-ui
person vabada    schedule 04.01.2016    source источник

Ответы (1)


arrow_upward
1
arrow_downward 

class MySourceView(generics.RetrieveUpdateDestroyAPIView):
    """
    MySource documentation
    """
    serializer_class = MySourceSerializer
    queryset = MySource.objects.all()

    def get(self, request, *args, **kwargs):
        """
        GET Documentation
        ---
            parameters_strategy: replace
            parameters:
                - name: pk
                  description: "Liverpool FC is the best."
                  required: true
                  type: string
                  paramType: path
                  defaultValue: 5
        """
        return self.retrieve(request, *args, **kwargs)

Вы можете сделать это как строку документации YAML в указанном методе. Подробнее см. Swagger RESTful API Documentation Specification 4.3.3 Поля типов данных

person Marosinho    schedule 20.06.2016