ModelSerializer
A ModelSerializer typically refers to a component of the Django REST framework (DRF).The Django REST framework is a popular toolkit for building Web APIs in Django applications. It provides a set of tools and libraries to simplify the process of building APIs, including serializers.
The ModelSerializer class provides a shortcut that lets you automatically create a Serializer class with fields that correspond to the Model fields.
The ModelSerializer class is the same as a regular Serializer class, except that:
- It will automatically generate a set of fields for you, based on the model.
- It will automatically generate validators for the serializer, such as unique_together validators.
- It includes simple default implementations of .create() and .update().
Syntax :
Python3
class SerializerName(serializers.ModelSerializer): class Meta: model = ModelName fields = List of Fields |
Models.py
Python3
from django.db import modelsclass Account(models.Model): user_id = model.IntegerField() account_name = model.CharField(max_lenght=50) user = model.CharField(max_length=100) created = models.DateTimeField(auto_now_add=True) |
Just like when building a form or model in Django, the first step in establishing a basic serializer is to import the serializers class from the rest framework and define the serializer’s fields.
Example :
Python3
class AccountSerializer(serializers.ModelSerializer): class Meta: model = Account fields = ['user_id', 'account_name', 'user', 'created'] |
By default, all the model fields on the class will be mapped to a corresponding serializer fields.
To checkout how to use ModelSerializer in your project, visit – ModelSerializer in serializers – Django REST Framework.
Serializers – Django REST Framework
The serializers in the REST framework work very similarly to Django’s Form and ModelForm classes. The two major serializers that are most popularly used are ModelSerializer and HyperLinkedModelSerialzer. This article revolves around how to use serializers from scratch in Django REST Framework to advanced serializer fields and arguments. It assumes one is familiar with How to start a project with Django REST Framework.
- Creating and Using Serializers
- ModelSerializer
- HyperLinkedModelSerializer
- Serializer Fields
- Core arguments in serializer fields