Required imports

fromdjango.dbimportmodelsfromrest_framework_tricks.models.fieldsimportNestedProxyField

Model definition

BOOK_PUBLISHING_STATUS_PUBLISHED='published'BOOK_PUBLISHING_STATUS_NOT_PUBLISHED='not_published'BOOK_PUBLISHING_STATUS_IN_PROGRESS='in_progress'BOOK_PUBLISHING_STATUS_CHOICES=((BOOK_PUBLISHING_STATUS_PUBLISHED,"Published"),(BOOK_PUBLISHING_STATUS_NOT_PUBLISHED,"Not published"),(BOOK_PUBLISHING_STATUS_IN_PROGRESS,"In progress"),)BOOK_PUBLISHING_STATUS_DEFAULT=BOOK_PUBLISHING_STATUS_PUBLISHEDclassBook(models.Model):"""Book."""title=models.CharField(max_length=100)description=models.TextField(null=True,blank=True)summary=models.TextField(null=True,blank=True)publication_date=models.DateField()state=models.CharField(max_length=100,choices=BOOK_PUBLISHING_STATUS_CHOICES,default=BOOK_PUBLISHING_STATUS_DEFAULT)isbn=models.CharField(max_length=100,unique=True)price=models.DecimalField(max_digits=10,decimal_places=2)pages=models.PositiveIntegerField(default=200)stock_count=models.PositiveIntegerField(default=30)# List the fields for `PublishingInformationSerializer` nested# serializer. This does not cause a model change.publishing_information=NestedProxyField('publication_date','isbn','pages',)# List the fields for `StockInformationSerializer` nested serializer.# This does not cause a model change.stock_information=NestedProxyField('stock_count','price','state',)classMeta:"""Meta options."""ordering=["isbn"]def__str__(self):returnself.title

Required imports

fromrest_frameworkimportserializersfromrest_framework_tricks.serializersimport(HyperlinkedModelSerializer,)from.modelsimportBook

Defining the serializers

classPublishingInformationSerializer(serializers.ModelSerializer):"""Publishing information serializer."""publication_date=serializers.DateField(required=False)isbn=serializers.CharField(required=False)pages=serializers.IntegerField(required=False)classMeta:"""Meta options."""model=Bookfields=('publication_date','isbn','pages',)# Note, that this should be set to True to identify that# this serializer is going to be used as `NestedProxyField`.nested_proxy_field=True

classStockInformationSerializer(serializers.ModelSerializer):"""Stock information serializer."""classMeta:"""Meta options."""model=Bookfields=('stock_count','price','state',)# Note, that this should be set to True to identify that# this serializer is going to be used as `NestedProxyField`.nested_proxy_field=True

# Note, that we are importing the ``HyperlinkedModelSerializer`` from# the `rest_framework_tricks.serializers`. Names of the serializers# should match the names of model properties set with ``NestedProxyField``# fields.classBookSerializer(HyperlinkedModelSerializer):"""Book serializer."""publishing_information=PublishingInformationSerializer(required=False)stock_information=StockInformationSerializer(required=False)classMeta:"""Meta options."""model=Bookfields=('url','id','title','description','summary','publishing_information','stock_information',)

Required imports

fromrest_framework.viewsetsimportModelViewSetfromrest_framework.permissionsimportAllowAnyfrom.modelsimportBookfrom.serializersimportBookSerializer

ViewSet definition

classBookViewSet(ModelViewSet):"""Book ViewSet."""queryset=Book.objects.all()serializer_class=BookSerializerpermission_classes=[AllowAny]

Sample OPTIONS call

OPTIONS /books/api/books/HTTP 200 OKAllow: GET, POST, HEAD, OPTIONSContent-Type: application/jsonVary: Accept

{"name":"Book List","description":"Book ViewSet.","renders":["application/json","text/html"],"parses":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"actions":{"POST":{"id":{"type":"integer","required":false,"read_only":true,"label":"ID"},"title":{"type":"string","required":true,"read_only":false,"label":"Title","max_length":100},"description":{"type":"string","required":false,"read_only":false,"label":"Description"},"summary":{"type":"string","required":false,"read_only":false,"label":"Summary"},"publishing_information":{"type":"nested object","required":false,"read_only":false,"label":"Publishing information","children":{"publication_date":{"type":"date","required":false,"read_only":false,"label":"Publication date"},"isbn":{"type":"string","required":false,"read_only":false,"label":"Isbn"},"pages":{"type":"integer","required":false,"read_only":false,"label":"Pages"}}},"stock_information":{"type":"nested object","required":false,"read_only":false,"label":"Stock information","children":{"stock_count":{"type":"integer","required":false,"read_only":false,"label":"Stock count"},"price":{"type":"decimal","required":true,"read_only":false,"label":"Price"},"state":{"type":"choice","required":false,"read_only":false,"label":"State","choices":[{"value":"published","display_name":"Published"},{"value":"not_published","display_name":"Not published"},{"value":"in_progress","display_name":"In progress"}]}}}}}}

Required imports

fromdjango.dbimportmodels

Model definition

classProfile(models.Model):"""Profile."""user=models.ForeignKey('auth.User')biography=models.TextField()hobbies=models.TextField()

Required imports

fromrest_frameworkimportserializersfrom.modelsimportProfile

Defining the serializers

classProfileSerializer(serializers.ModelSerializer):"""Profile serializer."""username=serializers.CharField(source='user.username',read_only=True)full_name=serializers.SerializerMethodField()email=serializers.CharField(source='user.email',read_only=True)classMeta(object):model=Profilefields=('id','username','full_name','email','biography','hobbies',)defget_full_name(self,obj):returnobj.user.get_full_name()

Required imports

fromrest_framework.viewsetsimportModelViewSetfromrest_framework.permissionsimportAllowAnyfromrest_framework_tricks.filtersimportOrderingFilterfrom.modelsimportProfilefrom.serializersimportProfileSerializer

ViewSet definition

classProfileViewSet(ModelViewSet):"""Profile ViewSet."""queryset=Profile.objects.all()serializer_class=ProfileSerializerpermission_classes=[AllowAny]filter_backends=(OrderingFilter,)ordering_fields={'id':'id','username':'user__username','email':'user__email','full_name':['user__first_name','user__last_name']}ordering=('id',)

Sample GET calls

Note, that our ordering options are now equal to the field names in theserializer (JSON response). API becomes easier to use/understand that way.

GET /api/profile/?ordering=emailGET /api/profile/?ordering=-usernameGET /api/profile/?ordering=full_nameGET /api/profile/?ordering=-full_name

Required imports

fromdjango.dbimportmodels

Model definition

classProfile(models.Model):"""Upload."""username=models.CharField(max_length=255)resume=models.FileField()

Required imports

fromrest_frameworkimportserializersfromrest_framework_tricks.fieldsimportConstrainedFileFieldfrom.modelsimportUpload

Defining the serializers

classProfileSerializer(serializers.ModelSerializer):"""Profile serializer."""username=serializers.CharField()# Restrict resume to 5Mbresume=ConstrainedFileField(max_upload_size=5_242_880)classMeta(object):model=Profilefields=('id','username','resume',)