drf-payload-customizer 0.0.1

This package allows you to customize your django-rest-framework serializer i/o to make modern frontend frameworks happy.

drf-payload-customizer

This package allows you to customize your django-rest-framework serializer i/o to make modern frontend frameworks happy.

Requirements

The mixin requires you to have the following dependencies:

djangorestframework==3.8.2
inflection==0.3.1

However, you will require Django==2.1.2 to run the unit tests.

Use it in your project

from drf_payload_customizer.mixins import PayloadCustomizationMixin

class CustomTestModelSerializer(PayloadCustomizationMixin, ModelSerializer):
    class Meta:
        model = TestModel
        fields = ('parama', 'param_b',)
        field_mappings = {
            'parama': 'paramA'
        }
        
# Now your serializer would output: 
test_serializer = CustomTestModelSerializer(obj)
JSONRenderer().render(test_serializer.data)
> {'paramA': '', 'paramB': None}

# Your serializer also admits input in the same format: 
content = json.dumps({'paramA': 'testA', 'paramB': 3}).encode()
stream = BytesIO(content)
data = JSONParser().parse(stream)
serializer = CustomTestModelSerializer(data=data)
self.assertTrue(serializer.is_valid())
> True

To run tests

cd drf_payload_customizer
# Make sure you change to a virutal environment according to your project setup
python setup.py install 
pip install -r requirements.txt 
cd tests/test_app/ 
python manage.py test