FastAPI эхлэл гарын авлага: өндөр гүйцэтгэлтэй API бүтээх шилдэг практик

Орчин үеийн арын хөгжүүлэлтэд FastAPI аажмаар тодорч, өндөр гүйцэтгэлтэй API бүтээх алдартай сонголт болж байна. Энэ гарын авлага нь танд FastAPI-ийн онцлог, давуу талуудыг гүнзгий ойлгуулах бөгөөд тодорхой алхмуудыг дагаж, хурдан суралцахад туслах болно. Ингэснээр та бодит төсөл дээр илүү үр дүнтэй API бүтээж, байршуулж чадна.

FastAPI гэж юу вэ?

FastAPI нь стандарт Python төрөл заавартай суурилсан орчин үеийн, хурдан (өндөр гүйцэтгэлтэй) вэб фреймворк юм. Энэ нь хөгжүүлэгчдэд хурдан API-уудыг энгийн аргаар бүтээх боломжийг олгож, гүйцэтгэл, сайн засварлах чадварыг хангадаг. Түүний гол онцлог нь:

• Өндөр гүйцэтгэл: Starlette (вэб хэсэгт) болон Pydantic (мэдээллийн хэсэгт) дээр суурилсан, Node.js болон Go-той ойролцоо гүйцэтгэлтэй.
• Автомат баримтжуулалт: OpenAPI болон JSON схемийн тусламжтайгаар FastAPI интерактив API баримтжуулалтыг автоматжуулдаг.
• Хэрэглэхэд хялбар: Python төрөл зааврыг ашигласнаар нийтлэг алдааг бууруулж, хөгжүүлэгчдийн үйлдвэрлэлийн үр ашгийг нэмэгдүүлдэг.
• Асинхрон програмчлалыг дэмждэг: `async` болон `await`-ийг дэмжиж, олон тооны хүсэлтийг боловсруулахад гүйцэтгэлтэй давуу талтай болгодог.

FastAPI-ийн давуу талууд

FastAPI нь уламжлалт фреймворкуудаас (жишээ нь Django болон Flask) илүү тодорхой давуу талуудтай:

1. Хурдан хөгжүүлэлт: Автоматжуулсан баримтжуулалт болон төрөл шалгалтын ачаар хөгжүүлэлтийн хурд ихээхэн нэмэгддэг.
2. Гүйцэтгэлтэй: Өндөр ачаалалтай програмуудыг боловсруулахад тохиромжтой, ялангуяа өндөр ачааллын үед илүү сайн гүйцэтгэлтэй.
3. Хүчтэй төрөл дэмжлэг: Төрөл зааварчилгаагаар гүйцэтгэлийн алдааг үр дүнтэй бууруулдаг.
4. Сайн тестийн дэмжлэг: Хамаарал оруулах болон хүсэлтийн загварууд нь тест хийх, алдааг засахад хялбар болгодог.

FastAPI-г хурдан суралцах

1. Орчны бэлтгэл

Эхлээд Python 3.7 эсвэл түүнээс дээш хувилбарыг суулгасан эсэхээ шалгаарай. Дараа нь FastAPI болон ASGI сервер Uvicorn-ийг суулгахын тулд дараах командыг ашиглана:

pip install fastapi uvicorn

2. Энгийн FastAPI аппликейшн үүсгэх

Дараа нь энгийн FastAPI аппликейшн үүсгэнэ. Таны ажиллах директорт `main.py` нэртэй шинэ файл үүсгээд, дараах агуулгыг оруулна:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"Hello": "World"}

@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "query": q}

3. Аппликейшн ажиллуулах

Uvicorn-ийг ашиглан FastAPI аппликейшнийг ажиллуулна:

uvicorn main:app --reload

Браузераар `http://127.0.0.1:8000` хаягаар орвол `{"Hello": "World"}` гэсэн хариу ирнэ. Мөн `http://127.0.0.1:8000/items/1?q=test` хаягаар орвол `{"item_id": 1, "query": "test"}` хариу ирнэ.

4. Автомат баримтжуулалт үүсгэх

FastAPI нь бүх замын хувьд баримтжуулалтыг автоматжуулдаг, та дараах URL-ийг ашиглан интерактив баримтжуулалтыг үзэж болно:

• Swagger UI: `http://127.0.0.1:8000/docs`
• ReDoc: `http://127.0.0.1:8000/redoc`

5. Мэдээллийн загвар ба баталгаажуулалт

FastAPI нь Pydantic-ийг ашиглан мэдээллийн загварыг үүсгэх, хүсэлтийн биеийг баталгаажуулахыг дэмждэг. Жишээ нь:

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float
    is_available: bool = True

@app.post("/items/")
async def create_item(item: Item):
    return item

Дээрх кодын хэсэг нь `Item` мэдээллийн загварыг тодорхойлж, FastAPI нь оруулсан JSON мэдээллийг автоматжуулан баталгаажуулна.

6. Асинхрон ба синхрон програмчлал

FastAPI нь асинхрон програмчлалыг дэмждэг, та `async def`-ийг ашиглан асинхрон замын функц тодорхойлж болно. Жишээ нь:

import asyncio

@app.get("/wait/")
async def wait_for_response():
    await asyncio.sleep(1)
    return {"message": "1 секунд хүлээсэн!"}

7. FastAPI аппликейшнийг байршуулалт хийх

FastAPI аппликейшнийг Docker, Kubernetes, үүлний үйлчилгээ зэрэг олон орчинд байршуулж болно. FastAPI-г Docker-ээр байршуулж буй энгийн жишээ:

# Dockerfile
FROM python:3.9

WORKDIR /app

COPY requirements.txt .
RUN pip install -r requirements.txt

COPY . .

CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

Дараа нь Docker зураг үүсгэж, ажиллуулна:

docker build -t myfastapiapp .
docker run -d -p 8000:8000 myfastapiapp

Та `http://localhost:8000` хаягаар орж, аппликейшнаа үзэж болно.

Шилдэг практик

1. Төрөл зааврыг ашиглах: Кодын уншигдах байдал, засварлах чадварыг сайжруулахын тулд үргэлж Python төрөл зааврыг ашиглаарай.
2. Параметр баталгаажуулалт: Бизнесийн шаардлагын дагуу тохирох параметр баталгаажуулалтыг тохируулж, API-д дамжуулж буй мэдээлэл нь хүчинтэй байгааг баталгаажуулна.
3. Алдааг төвлөрсөн байдлаар боловсруулах: Дэлхийн алдааг боловсруулахыг тодорхойлж, API нь алдааг зөвөөр боловсруулах боломжийг олгоно.
4. Баримтжуулалт ба тайлбар: API баримтжуулалтыг шинэчлэх, тайлбар, баримтжуулалтыг ашиглан кодын хандалтын боломжийг хадгалах.
5. Дундын програмчлалыг ашиглах: CORS, баталгаажуулалт зэрэг функцийг хэрэглэхийн тулд дундын програмчлалыг зөв ашиглаарай.

Дүгнэлт

FastAPI нь орчин үеийн өндөр гүйцэтгэлтэй API бүтээх хүчирхэг хэрэгсэл бөгөөд түүний үр дүнтэй, хялбар хэрэглээ нь хөгжүүлэгчдийн дунд өргөнөөр хүлээн зөвшөөрөгдсөн. Эхлэгчид болон туршлагатай хөгжүүлэгчид аль аль нь үүнээс ашиг хүртэх боломжтой. Бодит хөгжүүлэлтэд шилдэг практикуудыг хослуулан, та төслөө илүү үр дүнтэйгээр бүтээж, засварлах боломжтой болно. Энэ гарын авлага нь таны FastAPI суралцах аялалд заавар, тусламж болохыг найдаж байна!