Model request dan response

Menerapkan AI ke Produksi dengan FastAPI

Matt Eckerle

Software and Data Engineering Leader

Struktur request dan response di API

Struktur request

Data yang dikirim klien ke API
Biasanya mencakup:
- Metode HTTP (GET, POST, dll.)
- Header
- Parameter kueri
- Body request

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

:8000: Nomor port. FastAPI biasanya menggunakan 8000 sebagai default.
/users/: Path ke endpoint yang diakses.
?: Menandai awal parameter kueri.
`[email protected]`: Parameter kueri. Di sini kita mengirim alamat email ke endpoint.

Struktur response

Data yang dikirim balik oleh API ke klien
- Muatan respons JSON berisi informasi pengguna
Biasanya mencakup:
- Kode status (200 OK, 404 Not Found, dll.)
- Header
- Body respons (data diminta atau hasil operasi)

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

Pembuatan User
Penggunaan Pydantic

from pydantic import BaseModel

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

Mewarisi dari BaseModel
Mendefinisikan atribut dengan anotasi tipe
Validasi otomatis berdasarkan tipe

Kesalahan validasi

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]

Menggunakan model Pydantic di 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 digunakan sebagai response_model
Model digunakan sebagai petunjuk tipe parameter
Validasi request otomatis
De/serialisasi request/response
Menghasilkan dokumentasi API

Format request dan response

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
}

Ayo berlatih!

Menerapkan AI ke Produksi dengan FastAPI