Serializadores – Django REST Framework

Los serializadores en Django REST Framework son responsables de convertir objetos en tipos de datos comprensibles para javascript y marcos front-end. Los serializadores también brindan deserialización, lo que permite que los datos analizados se vuelvan a convertir en tipos complejos, después de validar primero los datos entrantes. Los serializadores en el marco REST funcionan de manera muy similar a las clases Form y ModelForm de Django. Los dos principales serializadores que se utilizan con más frecuencia son ModelSerializer e HyperLinkedModelSerialzer .
Este artículo gira en torno a cómo usar serializadores desde cero en Django REST Framework para campos y argumentos de serializadores avanzados. Se supone que uno está familiarizado con ¿Cómo iniciar un proyecto con Django REST Framework?

• Creación y uso de serializadores
• ModelSerializerModelSerializer
• Serializador de modelo hipervinculado
• Campos del serializador
• Argumentos centrales en los campos del serializador

Creación y uso de serializadores

Creación de un serializador básico

Para crear un serializador básico, es necesario importar la clase de serializadores desde rest_framework y definir campos para un serializador como si se creara un formulario o modelo en Django. 

Ejemplo  

# import serializer from rest_framework
from rest_framework import serializers
 
# create a serializer
class CommentSerializer(serializers.Serializer):
    # initialize fields
    email = serializers.EmailField()
    content = serializers.CharField(max_length = 200)
    created = serializers.DateTimeField()

De esta manera, se puede declarar el serializador para cualquier entidad u objeto en particular según los campos requeridos. Los serializadores se pueden utilizar para serializar y deserializar los datos.

Uso de Serializer para serializar datos

Ahora se puede usar CommentSerializer para serializar un comentario o una lista de comentarios. Una vez más, usar la clase Serializer se parece mucho a usar una clase Form. Primero creemos una clase de comentario para crear un objeto de tipo comentario que pueda ser entendido por nuestro serializador.  

# import datetime object
from datetime import datetime
 
# create a class
class Comment(object):
    def __init__(self, email, content, created = None):
        self.email = email
        self.content = content
        self.created = created or datetime.now()
# create a object
comment = Comment(email ='leila@example.com', content ='foo bar')

Ahora que nuestro objeto está listo, intentemos serializar este objeto de comentario. Ejecute el siguiente comando, 

Python manage.py shell

Ahora ejecuta el siguiente código  

# import comment serializer
>>> from apis.serializers import CommentSerializer

# import datetime for date and time
>>> from datetime import datetime

# create a object
>>> class Comment(object):
...     def __init__(self, email, content, created=None):
...         self.email = email
...         self.content = content
...         self.created = created or datetime.now()
... 

# create a comment object
>>> comment = Comment(email='leila@example.com', content='foo bar')

# serialize the data
>>> serializer = CommentSerializer(comment)

# print serialized data
>>> serializer.data

Ahora vamos a comprobar la salida de esto, 

Para obtener más información sobre cómo crear y usar un serializador, visite: Creación y uso de serializadores

ModelSerializerModelSerializer

La clase ModelSerializer proporciona un atajo que le permite crear automáticamente una clase Serializer con campos que corresponden a los campos del Modelo. 

La clase ModelSerializer es la misma que una clase Serializer regular, excepto que: 

• Generará automáticamente un conjunto de campos para usted, según el modelo.
• Generará automáticamente validadores para el serializador, como validadores únicos_juntos.
• Incluye implementaciones predeterminadas simples de .create() y .update().

Sintaxis –  

class SerializerName(serializers.ModelSerializer):
    class Meta:
        model = ModelName
        fields = List of Fields

Ejemplo – 

class AccountSerializer(serializers.ModelSerializer):
    class Meta:
        model = Account
        fields = ['id', 'account_name', 'users', 'created']

De forma predeterminada, todos los campos del modelo en la clase se asignarán a los campos del serializador correspondiente. 
Para ver cómo usar ModelSerializer en su proyecto, visite – ModelSerializer en serializadores – Django REST Framework . 

HyperlinkedModelSerializerHyperlinkedModelSerializer

La clase HyperlinkedModelSerializer es similar a la clase ModelSerializer excepto que usa hipervínculos para representar relaciones, en lugar de claves principales. De forma predeterminada, el serializador incluirá un campo de URL en lugar de un campo de clave principal. El campo URL se representará mediante un campo serializador HyperlinkedIdentityField y cualquier relación en el modelo se representará mediante un campo serializador HyperlinkedRelatedField.

Sintaxis –  

class SerializerName(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = ModelName
        fields = List of Fields

Ejemplo – 

class AccountSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Account
        fields = ['id', 'account_name', 'users', 'created']

Para ver cómo usar HyperLinkedModelSerializer en su proyecto, visite – HyperlinkedModelSerializer en serializadores – Django REST Framework .
 

Campos del serializador

Argumentos centrales en los campos del serializador

Los campos del serializador en Django son los mismos que los campos de formulario de Django y los campos de modelo de Django y, por lo tanto, requieren ciertos argumentos para manipular el comportamiento de esos campos.