Modele żądania i odpowiedzi

Wdrażanie AI na produkcję z FastAPI

Matt Eckerle

Software and Data Engineering Leader

Struktury żądania i odpowiedzi w API

Struktura żądania

Dane wysyłane przez klienta do API
Zazwyczaj zawiera:
- Metodę HTTP (GET, POST itd.)
- Nagłówki
- Parametry zapytania
- Ciało żądania

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

:8000: Numer portu. FastAPI domyślnie używa portu 8000.
/users/: Ścieżka do konkretnego endpointu.
?: Oznacza początek parametrów zapytania.
`[email protected]`: Parametr zapytania — adres e-mail przekazywany do endpointu.

Struktura odpowiedzi

Dane odesłane przez API do klienta
- Odpowiedź JSON z informacjami o użytkowniku
Zazwyczaj zawiera:
- Kod statusu (200 OK, 404 Not Found itd.)
- Nagłówki
- Ciało odpowiedzi (żądane dane lub wynik operacji)

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

Tworzenie User
Użycie Pydantic

from pydantic import BaseModel

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

Dziedziczy po BaseModel
Definiuje atrybuty z adnotacjami typów
Automatyczna walidacja na podstawie typów

Błąd walidacji

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]

Modele Pydantic w 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 używany jako response_model
Model używany jako typ parametru
Automatyczna walidacja żądań
Serializacja/deserializacja żądań i odpowiedzi
Generowanie dokumentacji API

Formaty żądania i odpowiedzi

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
}

Czas na ćwiczenia!

Wdrażanie AI na produkcję z FastAPI