如何使用Django REST序列化器？

Question

So, after reading the Django REST Framework document, and a bunch of tutorials, I am still having trouble understanding how to use the Django serializers to convert incoming POST (JSON) data into a Python object (sorry, I'm new).

Given that I am posting a JSON string to, say, api/foo/bar, how do I write its serializer?

Example JSON:

{ 'name': 'Mr. Foo', address:'Bar Street' }

My controller, Foo contains a bar method as follows:

@detail_route(
    methods=['post']
)
def bar(self, request, uuid=None):
    serializer = MySampleSerializer(data=request.DATA)

    something.clone(serializer.object)
    return Response(status=status.HTTP_201_CREATED)

Can somebody explain to me what should my serializer look like? And how do I access the serialized data from the serializer?

Answer 1

As you do not want to use a model, you have to create the serializer from scratch. Something like this should maybe work:

class MySerializer(serializers.Serializer):
    name = serializers.CharField(max_length = 100)
    adress = serializers.CharField(max_length = 100)

And then you could use it in a request like this:

def bar(self, request, uuid=None):
    data = JSONParser().parse(request)
    serializer = MySerializer(data = data)
    return Response(status=status.HTTP_201_CREATED)

Note however, as you have not created an Django model, you will not be able to save the serialized data (and thus nothing will be saved in the database)

Answer 2

Basically, you pass in the JSON data to the serializer, and then access the data field which will return an ordered dictionary.

def bar(self, request, uuid=None):
    serializer = MySampleSerializer(data=request.data)
    if serializer.is_valid(raise_exception=True):
        my_object = serializer.data # Grab the dict of values

To define a serializer:

class MySampleSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=30)
    address = serializers.CharField(max_length=30)

Answer 3

You do not have to use the ModelSerializer:

from rest_framework import serializers

class CommentSerializer(serializers.Serializer):
    email = serializers.EmailField()
    content = serializers.CharField(max_length=200)
    created = serializers.DateTimeField()

and access:

serializer = CommentSerializer(data=data)
serializer.is_valid()
# True
serializer.validated_data

by the way, all the above is from the DRF website