Request- en responsemodellen

AI in productie brengen met FastAPI

Matt Eckerle

Software and Data Engineering Leader

Request- en response-structuren in API's

Request-structuur

Data die de client naar de API stuurt
Bevat meestal:
- HTTP-methode (GET, POST, enz.)
- Headers
- Queryparameters
- Request body

http://localhost:8000/users/? [email protected]

:8000: Het poortnummer. FastAPI gebruikt standaard 8000.
/users/: Het pad naar de specifieke endpoint die we benaderen.
?: Marker voor het begin van de queryparameters.
`[email protected]`: De queryparameter. We geven hier een e-mailadres door aan de endpoint.

Response-structuur

Data die de API terugstuurt naar de client
- JSON-respons met gebruikersinformatie
Bevat meestal:
- Statuscode (200 OK, 404 Not Found, enz.)
- Headers
- Response body (gevraagde data of resultaat van de bewerking)

HTTP/1.1 200 OK
date: Fri, 18 Oct 2024 12:34:56 GMT
server: uvicorn
content-length: 76
content-type: application/json

{
  "username": "johndoe",
  "email": "[email protected]",
  "age": 30
}

Pydantic-model

Maken van User
Gebruik van Pydantic

from pydantic import BaseModel

class User(BaseModel):
    username: str
    email: str
    age: int

Erfdt van BaseModel
Definieert attributen met typeannotaties
Automatische validatie op basis van types

Validatiefout

from pydantic import ValidationError
try:
    invalid_user = User(username="john_doe", email="[email protected]", 
                        age="thirty")
    print("Invalid User:", invalid_user)
except ValidationError as e:
    print("Validation Error:", e)

Validation Error: 1 validation error for User age
Input should be a valid integer, unable to parse string as an integer 
[type=int_parsing, input_value='thirty', input_type=str]

Pydantic-modellen gebruiken in FastAPI

from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()


class User(BaseModel):
    username: str
    email: str
    age: int


@app.post("/users", response_model=User)

async def create_user(user: User):
    return user

Model gebruikt als response_model
Model gebruikt als typehint voor parameter
Automatische requestvalidatie
De-/serialisatie van request/response
Genereer API-docs

Request- en responseformaten

curl -X 'POST' \
  'http://localhost:8000/users/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "john_doe",
  "email": "[email protected]",
  "age": 30
  }'

{
  "username": "john_doe",
  "email": "[email protected]",
  "age": 30
}

Laten we oefenen!

AI in productie brengen met FastAPI