Versioning dan dokumentasi API

Menerapkan AI ke Produksi dengan FastAPI

Matt Eckerle

Software and Data Engineering Leader

Mengapa versioning API?

Endpoint API seperti item menu
Jaga pelanggan lama tetap puas
Beberapa pelanggan ingin opsi baru
Iterasi tanpa memengaruhi pelanggan yang ada

Sebuah restoran

API untuk pekerjaan AI di cloud

from pydantic import BaseModel

class AIJobV1(BaseModel):
    job_name: str
    data: bytes

class AIJobV1(BaseModel):
    job_name: str
    data: bytes
    config: dict

Logo FastAPI AI Cloud

Endpoint berversi

from pydantic import BaseModel

class AIJobV1(BaseModel):
    job_name: str
    data: bytes


class AIJobV2(BaseModel):
    job_name: str
    data: bytes
    config: dict

from fastapi import FastAPI

app = FastAPI()

@app.post("/v1/ai-job")
def ai_job_v1(job: AIJobV1):
    ...


@app.post("/v2/ai-job")
def ai_job_v2(job: AIJobV2):
    ...

Alasan memperbarui versi endpoint

Perubahan pemutus pada skema
Perubahan pada fungsi dasar
- Kode model diperbarui
- Himpunan data pelatihan model diperbarui
- Pra/pasca-pemrosesan diperbarui

Iterasi dengan field opsional

Versioning tidak selalu wajib untuk iterasi
Field opsional dapat menambah data tanpa merusak skema

from pydantic import BaseModel

class AIJobV1(BaseModel):
    job_name: str
    data: bytes


from typing import Optional

class AIJobV1(BaseModel):
    job_name: str
    data: bytes
    config: Optional[dict]

Mendokumentasikan API dengan Swagger

Alat standar untuk dokumentasi API
- Melacak endpoint dan versinya
- Dibangun di atas metadata standar OpenAPI

Logo OpenAPI

Swagger UI

URL Swagger Swagger UI

Swagger UI untuk sebuah endpoint

FastAPI Swagger UI untuk endpoint

Menggunakan field description FastAPI

from fastapi import FastAPI

app = FastAPI(
    description="AI Job API"
)

FastAPI Swagger UI dengan header deskripsi

Ayo berlatih!

Menerapkan AI ke Produksi dengan FastAPI