| Project | Status | |
|---|---|---|
| CI/CD |  |
|
| Quality |  |
|
| Package |
  
|
|
| Meta |
  
|
Provides a decorator for converting the drf serializer class to a dictionary
- Install package
pip install drf-serializer-dumps
serializer_dumps decorator is based on the assignment of fields in the serializer to generate a dict, for SerializerMethodField, the definition is made by OpenApiTypes or the usual python type hints.
- Optional parameters:
-
exclude_fieldsExclude a number of serializer fields when generating a dictionary. -
renew_type_valueGenerate a newuuidanddatetime, date, timewhen calling the function. -
extend_type_mapExpand the type dictionary to default values, new types and their values, or redefine existing types and their values.
-
from rest_framework import serializers
from drf_serializer_dumps.decorators import serializer_dumps
class PersonCars(serializers.Serializer):
car_name = serializers.CharField()
car_price = serializers.IntegerField()
class PersonSerializer(serializers.Serializer):
name = serializers.CharField()
age = serializers.IntegerField()
cars = PersonCars(many=True)
result = serializer_dumps(PersonSerializer)
print(result)
>>> {'name': 'string', 'age': 1, 'cars': [{'car_name': 'string', 'car_price': 1}]}from rest_framework import serializers
from django.contrib.postgres.fields import ArrayField
from drf_serializer_dumps.decorators import serializer_dumps
class Person(models.Model):
name = models.CharField(max_length=256)
phones = ArrayField(models.CharField(max_length=256))
class PersonSerializer(serializers.ModelSerializer):
class Meta:
model = Person
fields = '__all__'
result = serializer_dumps(PersonSerializer)
print(result)
>>> {'id': 1, 'name': 'string', 'phones': ['string']}Integration with drf-spectacular extend_schema decorator
@extend_schema(
examples=[
OpenApiExample('Name1', serializer_dumps(Some1Serializer)),
OpenApiExample('Name2', serializer_dumps(Some2Serializer)),
]
)
def your_api_method(self, request, *args, **kwargs):
...We would love you to contribute to drf-serializer-dumps, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
