drfextended 0.1
Django Model Serializer package
This package provides ability for developers to create serializers directly from models.
Installation
Install using pip:
pip install django-modelserializer
Usage
Models file:
from django.db import models
from django_modelserializer import APIMixin, APIModel, APIField
from rest_framework import serializers
class MyParentModel(APIMixin, models.Model):
"""You can inherit from APIMixin that provides serializer constructor method."""
name = models.CharField(max_length=64)
description = models.TextField()
api_fields = [
APIField('name'),
APIField('description'),
]
class MyModel(APIModel):
"""You can inherit from APIModel, that is inherited from APIMixin and models.Model"""
title = models.CharField(max_length=40)
parent = models.ForeignKey(MyParentModel, on_delete=models.CASCADE)
api_fields = [
# Plain serialize title as rest_framework does it out of the box.
APIField('title'),
# Serializer from foreign key field's model will be calculated automatically,
# if ForeingKey related model is subclass of APIMixin(or APIModel).
APIField('parent'),
# You can specify custom serializer for field.
APIField('parent_id', serializers.IntegerField(source='parent.id')),
]
Get serializer:
from .models import MyModel
MyModelSerializer = MyModel.get_serializer_class()
Here, MyModelSerializer is equal to:
from rest_framework import serializers
from .models import MyParentModel
class MyParentModelSerializer(serializers.ModelSerializer):
class Meta:
model = MyParentModel
fields = ('name', 'description')
class MyModelSerializer(serializers.ModelSerializer):
parent = MyParentModelSerializer()
class Meta:
fields = ('title', 'parent', 'parent_id')
Use in views:
from rest_framework.generics import RetrieveAPIView
from .models import MyModel
class MyModelRetrieveView(RetrieveAPIView):
serializer_class = MyModel.get_serializer_class()
queryset = MyModel.objects.select_related('parent').all()
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
There are no reviews.