การกำหนดเวอร์ชันและเอกสารประกอบ API

การ Deploy AI สู่ Production ด้วย FastAPI

Matt Eckerle

Software and Data Engineering Leader

ทำไมต้องกำหนดเวอร์ชัน API?

API endpoint เปรียบเหมือนรายการอาหาร
รักษาความพึงพอใจของลูกค้าเดิม
ลูกค้าบางส่วนต้องการตัวเลือกใหม่
พัฒนาต่อเนื่องโดยไม่กระทบผู้ใช้เดิม

ร้านอาหาร

API สำหรับงาน AI บนคลาวด์

from pydantic import BaseModel

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

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

โลโก้ FastAPI AI Cloud

Endpoint แบบมีเวอร์ชัน

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):
    ...

เหตุผลในการอัปเดตเวอร์ชัน endpoint

Schema มีการเปลี่ยนแปลงที่ไม่เข้ากัน
ฟังก์ชันหลักเปลี่ยนแปลง
- โค้ดโมเดลอัปเดต
- ชุดข้อมูลฝึกโมเดลอัปเดต
- การประมวลผลก่อน/หลังอัปเดต

การพัฒนาด้วยฟิลด์ optional

การกำหนดเวอร์ชันไม่จำเป็นเสมอไปเมื่อต้องพัฒนาต่อ
ฟิลด์ที่เป็น optional รองรับข้อมูลเพิ่มเติมโดยไม่ทำให้ schema เสียหาย

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]

การทำเอกสาร API ด้วย Swagger

เครื่องมือมาตรฐานสำหรับเอกสาร API
- ติดตาม endpoint และเวอร์ชันต่างๆ
- สร้างบน metadata มาตรฐาน OpenAPI

โลโก้ OpenAPI

Swagger UI

URL ของ Swagger Swagger UI

Swagger UI สำหรับ endpoint

FastAPI Swagger UI สำหรับ endpoint

การใช้ฟิลด์ description ของ FastAPI

from fastapi import FastAPI

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

FastAPI Swagger UI พร้อมหัวข้อคำอธิบาย

มาฝึกกันเถอะ!

การ Deploy AI สู่ Production ด้วย FastAPI