FastAPI кіріспе нұсқаулығы: Жоғары өнімді API құрудың үздік тәжірибелері

Заманауи артқы дамуында FastAPI біртіндеп танымал бола бастады, жоғары өнімді API құрудың танымал таңдауы болып табылады. Бұл нұсқаулық сізді FastAPI-дің ерекшеліктері, артықшылықтары және нақты қадамдар арқылы тез үйрену жолымен таныстырады, сізге нақты жобаларда API-ді тиімдірек құру мен орналастыруға көмектеседі.

FastAPI дегеніміз не?

FastAPI - стандартты Python типтік белгілеріне негізделген заманауи, жылдам (жоғары өнімді) веб-фреймворк. Ол әзірлеушілерге жылдам API құруға мүмкіндік береді, сонымен қатар тиімді жұмыс жылдамдығы мен жақсы қолдау көрсетуді қамтамасыз етеді. Оның негізгі ерекшеліктері:

• Жоғары өнімділік: Starlette (веб бөлігі үшін) және Pydantic (деректер бөлігі үшін) негізінде, өнімділігі Node.js және Go-ға жақын.
• Автоматты құжаттама генерациясы: OpenAPI және JSON Schema арқылы 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 оқу сапарыңызға бағыт пен көмек көрсетуі мүмкін!