Serializer validation in Django - Mini Project: Build & Apply

Serializer validation

📖 Scenario: You are building a simple Django REST API for a bookstore. You want to ensure that the data sent to your API is valid before saving it to the database.

🎯 Goal: Create a serializer for a Book model and add validation to check that the price is not negative.

📋 What You'll Learn

Create a serializer class for the Book model

Add a field for title and price

Add a validation method to ensure price is zero or positive

Raise a validation error if price is negative

💡 Why This Matters

🌍 Real World

APIs often need to check data before saving to avoid errors or bad data in the database.

💼 Career

Knowing how to add validation in serializers is essential for backend developers working with Django REST Framework.

1

Create the BookSerializer class

Create a serializer class called BookSerializer that inherits from serializers.Serializer. Add two fields: title as a serializers.CharField() and price as a serializers.FloatField().

Django

from rest_framework import serializers

# Create BookSerializer class with title and price fields
# Your code here

Hint

Remember to import serializers from rest_framework and define the fields inside the class.

2

Add a validation method for price

Inside the BookSerializer class, add a method called validate_price that takes self and value as parameters.

Django

from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    title = serializers.CharField()
    price = serializers.FloatField()

    # Add validate_price method below
    # Your code here

Hint

The validation method should return the value if it is valid.

3

Add validation logic to check for negative price

Inside the validate_price method, add an if statement to check if value is less than 0. If it is, raise serializers.ValidationError with the message "Price cannot be negative". Otherwise, return the value.

Django

from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    title = serializers.CharField()
    price = serializers.FloatField()

    def validate_price(self, value):
        # Add check for negative price
        # Your code here

Hint

Use an if statement to check the value and raise the error if needed.

4

Complete the serializer with validation

Ensure the BookSerializer class includes the title and price fields and the validate_price method with the negative price check and error raising.

Django

from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    title = serializers.CharField()
    price = serializers.FloatField()

    def validate_price(self, value):
        if value < 0:
            raise serializers.ValidationError("Price cannot be negative")
        return value

# Serializer complete

Hint

Review the whole class to ensure all parts are included correctly.

Practice

1. What is the main purpose of serializer validation in Django REST Framework?

easy

A. To check if the input data is correct before saving or processing

B. To automatically save data to the database

C. To format the output data for display

D. To create database tables automatically

Solution

1. Step 1: Understand serializer validation role

   Serializer validation ensures the data received is correct and meets rules before using it.

2. Step 2: Differentiate from other serializer tasks

   Saving data or formatting output are separate steps; validation happens first to prevent errors.

3. Final Answer:

   To check if the input data is correct before saving or processing -> Option A

4. Quick Check:

   Validation = Data correctness check [OK]

Hint: Validation checks data correctness before saving or using it [OK]

Common Mistakes:

• Confusing validation with saving data
• Thinking validation formats output
• Assuming validation creates database tables

2. Which method name is correct to validate a single field called email in a serializer?

easy

A. validateEmail

B. validate_field_email

C. check_email

D. validate_email

Solution

1. Step 1: Recall Django REST Framework naming convention

   Single field validation methods must be named validate_<fieldname>.

2. Step 2: Match method name to field email

   The correct method is validate_email, exactly matching the field name.

3. Final Answer:

   validate_email -> Option D

4. Quick Check:

   Single field validator = validate_fieldname [OK]

Hint: Use validate_ plus field name exactly for single field validation [OK]

Common Mistakes:

• Using camelCase instead of snake_case
• Adding extra words like 'field' in method name
• Using incorrect prefixes like 'check_'

3. Given this serializer code, what will happen if age is less than 18?

class UserSerializer(serializers.Serializer):
    age = serializers.IntegerField()

    def validate_age(self, value):
        if value < 18:
            raise serializers.ValidationError('Must be at least 18')
        return value

medium

A. ValidationError with message 'Must be at least 18' is raised

B. The age is automatically set to 18

C. No error, age is accepted as is

D. Serializer ignores the age field

Solution

1. Step 1: Understand the validate_age method logic

   The method checks if age is less than 18 and raises ValidationError if true.

2. Step 2: Predict behavior when age < 18

   If age is less than 18, the error is raised stopping validation and returning the message.

3. Final Answer:

   ValidationError with message 'Must be at least 18' is raised -> Option A

4. Quick Check:

   Age < 18 triggers ValidationError [OK]

Hint: ValidationError raised when condition inside validate_<field> fails [OK]

Common Mistakes:

• Assuming age is changed automatically
• Thinking no error occurs for invalid age
• Believing the field is ignored silently

4. Identify the error in this serializer validation code:

class ProductSerializer(serializers.Serializer):
    price = serializers.FloatField()

    def validate(self, data):
        if data['price'] < 0:
            raise serializers.ValidationError('Price must be positive')
        return data

    def validate_price(self, value):
        if value == 0:
            raise serializers.ValidationError('Price cannot be zero')
        return value

medium

A. validate method should call super().validate(data)

B. validate_price should return data, not value

C. No error, code is correct

D. ValidationError messages must be dictionaries, not strings

Solution

1. Step 1: Check validate_price method

   It correctly checks if value is zero and raises error, then returns value.

2. Step 2: Check validate method

   It checks if price is negative and raises error, then returns data dictionary.

3. Step 3: Confirm ValidationError usage

   Passing string message is allowed; dictionary is optional for field-specific errors.

4. Final Answer:

   No error, code is correct -> Option C

5. Quick Check:

   Both validate and validate_<field> methods are valid [OK]

Hint: Both validate and validate_<field> can coexist and return correct types [OK]

Common Mistakes:

• Expecting validate_price to return data dict
• Thinking super().validate(data) is mandatory
• Believing ValidationError must be dict only

5. You want to validate that start_date is before end_date in a serializer. Which is the best way to do this?

hard

A. Use validate_start_date to compare both dates

B. Use the validate(self, data) method to compare both fields

C. Validate dates outside the serializer only

D. Use validate_end_date to compare both dates

Solution

1. Step 1: Understand single field validators scope

   Methods like validate_start_date only receive one field's value, so cannot compare two fields.

2. Step 2: Use validate method for multi-field validation

   The validate(self, data) method receives all fields and can compare start_date and end_date together.

3. Final Answer:

   Use the validate(self, data) method to compare both fields -> Option B

4. Quick Check:

   Multi-field validation = validate(data) method [OK]

Hint: Use validate(data) for checks involving multiple fields [OK]

Common Mistakes:

• Trying to compare fields inside single field validators
• Ignoring multi-field validation method
• Doing validation only outside serializer