คุณเพิ่มข้อจำกัดในการตรวจสอบ (validation constraints) ให้พารามิเตอร์ได้อย่างไร?

Question

Accepted Answer

นอกเหนือจากการตรวจสอบชนิดข้อมูล FastAPI ยังให้คุณเพิ่ม **constraints** ให้กับ path/query parameters และ model fields ได้โดยใช้ `Query`, `Path` และ `Field` — บังคับใช้กฎต่าง ๆ เช่น ความยาว ช่วงค่า และ patterns พร้อมทั้งสร้าง error 422 และเอกสารโดยอัตโนมัติเมื่อมีการละเมิด ## ข้อจำกัดของ Query และ Path ```python from fastapi import Query, Path @app.get("/items") def search( q: str = Query(min_length=3, max_length=50), # string length bounds page: int = Query(default=1, ge=1), # >= 1 limit: int = Query(default=10, ge=1, le=100), # 1 <= limit <= 100 code: str = Query(pattern=r"^[A-Z]{3}$"), # regex pattern ): ... @app.get("/items/{item_id}") def get(item_id: int = Path(ge=1)): # path param must be >= 1 ... ``` `Query()` และ `Path()` เพิ่มข้อจำกัดให้กับ query และ path parameters ตัวที่ใช้บ่อย ได้แก่ `min_length`/`max_length` (strings), `ge`/`gt`/`le`/`lt` (numbers), `pattern` (regex) การละเมิดจะสร้าง error 422 ที่ชัดเจนโดยอัตโนมัติ ## ข้อจำกัดของ Field บน Pydantic models ```python from pydantic import BaseModel, Field, EmailStr class User(BaseModel): name: str = Field(min_length=1, max_length=100) age: int = Field(ge=0, le=120) email: EmailStr # format validation via a type bio: str = Field(default="", max_length=500, description="User bio") ``` ข้อจำกัดเดียวกันใช้กับ model fields ได้ผ่าน `Field()` เพื่อตรวจสอบ request bodies ชนิดข้อมูลเฉพาะทาง (`EmailStr`, `HttpUrl`, `UUID`) จะตรวจสอบรูปแบบให้ ## ข้อจำกัดยังช่วยเสริมเอกสารด้วย ```python q: str = Query(min_length=3, description="Search query", example="phone") # the constraints + description + example appear in the auto-generated API docs ``` ทุกข้อจำกัดที่คุณประกาศจะถูกสะท้อนในเอกสาร OpenAPI ด้วย ดังนั้นผู้ใช้งานจะเห็นกฎเหล่านั้น ## ทำไมจึงสำคัญ การเพิ่ม validation constraints มีความสำคัญทั้งต่อ **ความปลอดภัย/ความแข็งแกร่ง** และการออกแบบ API ที่ดี — การประกาศกฎ (ขีดจำกัดความยาว ช่วงค่าตัวเลข regex patterns ชนิดของรูปแบบ) ทำให้แน่ใจว่า input ที่ผิดรูปแบบหรือเป็นอันตรายจะถูกปฏิเสธพร้อม error ที่ชัดเจน *ก่อน* ที่จะไปถึง logic ของคุณ ซึ่งเป็นสิ่งจำเป็นเพราะคุณต้องไม่ไว้วางใจ input ดิบ FastAPI ทำให้สิ่งนี้เป็นแบบประกาศ (declarative) และไม่ต้องออกแรง: ข้อจำกัด `Query`/`Path`/`Field` จะถูกตรวจสอบโดยอัตโนมัติ (สร้าง error 422 ที่มีโครงสร้าง) และถูกบันทึกในเอกสาร API ไปพร้อมกัน ดังนั้นกฎจึงถูกบังคับใช้และสื่อสารจากการประกาศเพียงครั้งเดียว การรู้จัก constraints ที่ใช้บ่อยและชนิด validation เฉพาะทางเป็นความรู้พื้นฐานในการสร้าง endpoint ที่ปลอดภัยและมีการนิยามที่ดี — เป็นวิธีที่คุณก้าวข้ามการตรวจสอบชนิดข้อมูลพื้นฐานไปสู่การบังคับใช้กฎทางธุรกิจที่ข้อมูลของคุณต้องเป็นไปตามนั้นจริง ๆ