Scribd
Upload
2 views9 pages

Serving Structured Data Using Pydantic Models Slides

The document discusses how to serve structured data using Pydantic models, focusing on operations that add or change data through an API. It covers HTTP methods like GET, POST, PUT, and DELETE, along with the implementation of input and output schemas using Pydantic. Additionally, it highlights the use of Postman for API testing and mentions future integration with a database.

Uploaded by

Nikhil Pandey
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
2 views9 pages

Serving Structured Data Using Pydantic Models Slides

The document discusses how to serve structured data using Pydantic models, focusing on operations that add or change data through an API. It covers HTTP methods like GET, POST, PUT, and DELETE, along with the implementation of input and output schemas using Pydantic. Additionally, it highlights the use of Postman for API testing and mentions future integration with a database.

Uploaded by

Nikhil Pandey
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 9

Serving Structured Data Using

Pydantic Models

Reindert-Jan Ekker

@rjekker www.codesensei.nl
Operations that add/change data
Overview Structured data
- Pydantic model classes
- Save/load as JSON file

Input and Output schemas


- Request and Response body

Calling our API using Postman


- Using openapi.json
HTTP Methods

GET /api/cars/5
POST /api/cars
Retrieve data – dont change
Add a new item. Data in body.
anything.

PUT /api/cars/5
DELETE /api/cars/5
Replace resource: update a car.
Remove a car
Data in body.
from pydantic import BaseModel

class Car(BaseModel):
id: int
fuel: str|None = "electric"
trips: list[Trip] = []

# BaseModel functionality
car = Car(id=5, fuel=“gas”) # __init__

# Convert to json, dict, str


car.json(), car.dict(), str(car)

Using pydantic Models


Inherit from pydantic.BaseModel
List fields with types as class attributes
Can include (collections of) other Model objects
Get lots of standard functionality (see https://pydantic-docs.helpmanual.io/)
Separate Input and Output Models

carsharing.py schemas.py

from schemas import CarInput, CarOutput from pydantic import BaseModel

@app.post("/api/cars/") class CarInput(BaseModel):


def add_car(car: CarInput) -> CarOutput: size: str
# Create new_car based on input fuel: str|None = "electric"
new_car = CarOutput(...)
# Save new car...
return new_car class CarOutput(CarInput):
id: int
@app.put("/api/cars/{id}")
def change_car(id: int, new_data: CarInput) -> CarOutput:
car = find_car_by_id(id)
if car:
# update car with data from new_data
# save, and return
else:
raise HTTPException(status_code=404,
detail=f"No car with id={id}.")

Pydantic Models in Request and Response


id is a path parameter (from URL)
new_data is a pydantic model so it’s read from the request body
Setting the Default Status Code

@app.delete("/api/cars/{id}", status_code=204)
def remove_car(id: int) -> None:
car = find_car_by_id()
if car:
# Remove car and save
# No return needed
else:
raise HTTPException(status_code=404,
detail=f"No car with id={id}.")
Overview POST, PUT, DELETE Operations
Structured data with Pydantic
- Input and output schemas
- Request/response body
- Nested models

Using openapi.json with Postman


Up Next: Using a Database

You might also like