Modely požadavků a odpovědí

Nasazení AI do produkce s FastAPI

Matt Eckerle

Software and Data Engineering Leader

Struktury požadavků a odpovědí v API

Struktura požadavku

Data odeslaná klientem do API
Obvykle zahrnuje:
- HTTP metodu (GET, POST atd.)
- Hlavičky
- Parametry dotazu
- Tělo požadavku

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

:8000: Číslo portu. FastAPI standardně používá port 8000.
/users/: Cesta ke konkrétnímu endpointu.
?: Označuje začátek parametrů dotazu.
`[email protected]`: Parametr dotazu – zde je předávána e-mailová adresa.

Struktura odpovědi

Data odeslaná zpět z API klientovi
- JSON payload s informacemi o uživateli
Obvykle zahrnuje:
- Stavový kód (200 OK, 404 Not Found atd.)
- Hlavičky
- Tělo odpovědi (požadovaná data nebo výsledek operace)

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
}

Model Pydantic

Vytvoření třídy User
Použití Pydantic

from pydantic import BaseModel

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

Dědí z BaseModel
Definuje atributy s typovými anotacemi
Automatická validace na základě typů

Chyba validace

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]

Použití modelů Pydantic ve 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 použit jako response_model
Model použit jako typový parametr
Automatická validace požadavků
De/serializace požadavku/odpovědi
Generování dokumentace API

Formáty požadavku a odpovědi

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
}

Pojďme cvičit!

Nasazení AI do produkce s FastAPI