Custom validation with validator decorator in FastAPI - Mini Project: Build & Apply

Custom validation with validator decorator in FastAPI

📖 Scenario: You are building a simple FastAPI app to register users. You want to make sure the user's username is at least 3 characters long and contains only letters and numbers.

🎯 Goal: Create a Pydantic model with a custom validator using the @validator decorator to check the username field. The validator should raise an error if the username is too short or contains invalid characters.

📋 What You'll Learn

Create a Pydantic model called User with a username field of type str.

Add a class method decorated with @validator('username') to validate the username.

The validator must check that username is at least 3 characters long.

The validator must check that username contains only letters and numbers.

Raise a ValueError with a clear message if validation fails.

💡 Why This Matters

🌍 Real World

Custom validation is essential in web APIs to ensure user input meets rules before saving or processing. This prevents errors and security issues.

💼 Career

Backend developers often write custom validators in FastAPI or similar frameworks to enforce business rules and data integrity.

1

Create the User model with username field

Create a Pydantic model called User with a single field username of type str.

FastAPI

from pydantic import BaseModel

# Create User model with username field
# Your code here

Hint

Use class User(BaseModel): and define username: str inside.

2

Import the validator decorator

Add an import statement to import validator from pydantic.

FastAPI

from pydantic import BaseModel
# Import validator decorator
# Your code here

class User(BaseModel):
    username: str

Hint

Use from pydantic import validator to import the decorator.

3

Add a custom validator for username

Inside the User model, add a class method decorated with @validator('username') named check_username. It should accept cls and value parameters. Check if value is at least 3 characters long and contains only letters and numbers using value.isalnum(). If not, raise ValueError with the message 'Username must be at least 3 characters and alphanumeric'. Return value if valid.

FastAPI

from pydantic import BaseModel, validator

class User(BaseModel):
    username: str

    # Add validator method for username
    # Your code here

Hint

Use @validator('username') above a method that checks length and isalnum().

4

Complete the FastAPI app with POST endpoint

Add the necessary imports from fastapi and create a FastAPI app instance called app. Add a POST endpoint /users/ that accepts a User model as input and returns the same User object as JSON.

FastAPI

from pydantic import BaseModel, validator
from fastapi import FastAPI

class User(BaseModel):
    username: str

    @validator('username')
    def check_username(cls, value):
        if len(value) < 3 or not value.isalnum():
            raise ValueError('Username must be at least 3 characters and alphanumeric')
        return value

# Create FastAPI app and POST endpoint
# Your code here

Hint

Import FastAPI, create app = FastAPI(), then add a POST route /users/ that returns the User object.

Practice

1. What is the main purpose of using the @validator decorator in a Pydantic model within FastAPI?

easy

A. To define database relationships

B. To automatically generate API routes

C. To add custom validation logic for model fields

D. To format the output JSON response

Solution

1. Step 1: Understand the role of @validator

   The @validator decorator is used inside Pydantic models to add custom validation logic for fields.

2. Step 2: Differentiate from other functionalities

   It does not generate routes, define database relations, or format output JSON; those are handled elsewhere.

3. Final Answer:

   To add custom validation logic for model fields -> Option C

4. Quick Check:

   Custom validation = To add custom validation logic for model fields [OK]

Hint: Remember: @validator checks field values before use [OK]

Common Mistakes:

• Confusing validation with route creation
• Thinking it formats output JSON
• Assuming it manages database relations

2. Which of the following is the correct syntax to create a validator for the field email in a Pydantic model?

easy

A. @validator['email']\ndef check_email(cls, value):\n return value

B. @validate('email')\ndef check_email(cls, value):\n return value

C. @validator(email)\ndef check_email(cls, value):\n return value

D. @validator('email')\ndef check_email(cls, value):\n return value

Solution

1. Step 1: Identify correct decorator usage

   The correct decorator is @validator('field_name') with the field name as a string.

2. Step 2: Check syntax correctness

   @validator('email')\ndef check_email(cls, value):\n return value uses @validator('email') correctly; others use wrong decorator names or syntax.

3. Final Answer:

   @validator('email')\ndef check_email(cls, value):\n return value -> Option D

4. Quick Check:

   Correct decorator syntax = @validator('email')\ndef check_email(cls, value):\n return value [OK]

Hint: Use quotes around field name in @validator [OK]

Common Mistakes:

• Omitting quotes around field name
• Using wrong decorator name like @validate
• Using brackets [] instead of parentheses ()

3. Given the following Pydantic model, what will happen if you create an instance with age=15?

from pydantic import BaseModel, validator

class User(BaseModel):
    age: int

    @validator('age')
    def check_age(cls, v):
        if v < 18:
            raise ValueError('Must be at least 18')
        return v

user = User(age=15)

medium

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

B. The user instance is created with age 15

C. The age is automatically set to 18

D. A TypeError is raised because age is int

Solution

1. Step 1: Analyze the validator logic

   The validator checks if age is less than 18 and raises a ValueError if true.

2. Step 2: Apply input value to validator

   Since age=15 is less than 18, the validator raises the error with the message.

3. Final Answer:

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

4. Quick Check:

   Age < 18 triggers ValueError = A ValueError is raised with message 'Must be at least 18' [OK]

Hint: Validator raises error if condition fails [OK]

Common Mistakes:

• Assuming instance is created despite validation error
• Thinking age auto-corrects to 18
• Confusing ValueError with TypeError

4. Identify the error in this validator code snippet:

from pydantic import BaseModel, validator

class Product(BaseModel):
    price: float

    @validator('price')
    def check_price(value):
        if value <= 0:
            raise ValueError('Price must be positive')
        return value

medium

A. Validator decorator should be @validate

B. Missing cls parameter in validator method

C. Return statement is missing

D. Field name in decorator should be price without quotes

Solution

1. Step 1: Check validator method signature

   Validator methods must have cls as the first parameter, then the value.

2. Step 2: Identify missing parameter

   The method only has value, missing cls, causing a TypeError.

3. Final Answer:

   Missing cls parameter in validator method -> Option B

4. Quick Check:

   Validator method needs cls first = Missing cls parameter in validator method [OK]

Hint: Validator methods always start with cls, then value [OK]

Common Mistakes:

• Omitting cls parameter
• Using wrong decorator name
• Forgetting to return the value

5. You want to create a Pydantic model that validates a username field to ensure it is at least 3 characters long and contains only letters and numbers. Which validator implementation correctly achieves this?

hard

A. from pydantic import BaseModel, validator
import re

class User(BaseModel):
username: str

@validator('username')
def valid_username(cls, v):
if len(v) < 3 or not re.match(r'^[a-zA-Z0-9]+$', v):
raise ValueError('Username must be 3+ chars and alphanumeric')
return v

B. from pydantic import BaseModel, validator

class User(BaseModel):
username: str

@validator('username')
def valid_username(cls, v):
if len(v) > 3 and v.isalnum():
raise ValueError('Username must be 3+ chars and alphanumeric')
return v

C. from pydantic import BaseModel, validator

class User(BaseModel):
username: str

@validator('username')
def valid_username(cls, v):
if len(v) < 3 or not v.isalpha():
raise ValueError('Username must be 3+ chars and letters only')
return v

D. from pydantic import BaseModel, validator
import re

class User(BaseModel):
username: str

@validator('username')
def valid_username(cls, v):
if len(v) < 3 or not re.match(r'^[a-z]+$', v):
raise ValueError('Username must be 3+ chars and lowercase letters only')
return v

Solution

1. Step 1: Check length and character conditions

   The username must be at least 3 characters and only letters or numbers.

2. Step 2: Evaluate each option's validation logic

   from pydantic import BaseModel, validator import re class User(BaseModel): username: str @validator('username') def valid_username(cls, v): if len(v) < 3 or not re.match(r'^[a-zA-Z0-9]+$', v): raise ValueError('Username must be 3+ chars and alphanumeric') return v correctly checks length & uses regex to allow letters and numbers only. Others either check wrong conditions or restrict letters only.

3. Final Answer:

   Option A correctly validates username length and alphanumeric characters -> Option A

4. Quick Check:

   Length >=3 and alphanumeric = from pydantic import BaseModel, validator import re class User(BaseModel): username: str @validator('username') def valid_username(cls, v): if len(v) < 3 or not re.match(r'^[a-zA-Z0-9]+$', v): raise ValueError('Username must be 3+ chars and alphanumeric') return v [OK]

Hint: Use regex to check alphanumeric and length together [OK]

Common Mistakes:

• Using isalpha() instead of isalnum()
• Checking length incorrectly (greater than vs less than)
• Restricting to letters only when numbers allowed