Usage

Serializer

Serializers that inherit from DynamicFieldsSerializer can be configured using the following keyword arguments:

  • included_fields: list of field names to include in the serializer.

  • excluded_fields: list of field names to exclude from the serializer.

  • required_fields: list of field names that are required.

  • non_nullable_fields: list of field names that are non-nullable.

class PaymentSerializer(DynamicFieldsModelSerializer):
    id = serializers.IntegerField(allow_null=False, required=True)
    mutation = MutationSerializer()

    class Meta:
        model = Payment
        fields = "__all__"

View

class PaymentViewSet(DynamicFieldsModelViewSet):
    serializer_class = PaymentSerializer  # serializer that inherits from DynamicFieldsModelSerializer

Example URLs:

  • /payments/?fields=id,mutation.delta

  • /payments/?exclude=id,mutation.delta