FastAPI Panimula: Mga Pinakamahusay na Kasanayan sa Paggawa ng Mataas na Pagganap na API

Sa modernong pagbuo ng backend, unti-unting lumilitaw ang FastAPI bilang isang tanyag na pagpipilian para sa paggawa ng mataas na pagganap na API. Ang gabay na ito ay magdadala sa iyo sa malalim na pag-unawa sa mga katangian, benepisyo ng FastAPI, at kung paano mabilis na makapagsimula sa pamamagitan ng mga tiyak na hakbang, na makakatulong sa iyo na mas mahusay na makabuo at makapag-deploy ng API sa mga aktwal na proyekto.

Ano ang FastAPI?

Ang FastAPI ay isang modernong, mabilis (mataas na pagganap) na Web framework, batay sa mga pamantayang uri ng Python. Pinapayagan nito ang mga developer na lumikha ng mabilis na API sa isang simpleng paraan, habang tinitiyak ang mahusay na bilis ng pagpapatakbo at magandang maintainability. Ang mga pangunahing katangian nito ay kinabibilangan ng:

Mataas na Pagganap: Batay sa Starlette (para sa bahagi ng Web) at Pydantic (para sa bahagi ng data), ang pagganap ay malapit sa Node.js at Go.
Awtomatikong Pagbuo ng Dokumentasyon: Sa pamamagitan ng OpenAPI at JSON Schema, ang FastAPI ay awtomatikong bumubuo ng interactive na dokumentasyon ng API.
Madaling Gamitin: Gumagamit ng mga uri ng Python, binabawasan ang mga karaniwang pagkakamali, at pinapataas ang produktibidad ng mga developer.
Suporta sa Asynchronous Programming: Sinusuportahan ang async at await, na nagbibigay ng mas mahusay na pagganap kapag humahawak ng maraming mga kahilingan.

Mga Benepisyo ng FastAPI

Ang FastAPI ay may mga makabuluhang benepisyo kumpara sa mga tradisyunal na framework (tulad ng Django at Flask):

Mabilis na Pagbuo: Dahil sa awtomatikong nabubuong dokumentasyon at uri ng pagsusuri, ang bilis ng pagbuo ay makabuluhang tumaas.
Mabisang Pagganap: Angkop para sa paghawak ng mataas na concurrency na mga aplikasyon, lalo na sa ilalim ng mataas na load.
Malakas na Suporta sa Uri: Sa pamamagitan ng mga uri ng pagsusuri, epektibong nababawasan ang mga pagkakamali sa runtime.
Magandang Suporta sa Pagsubok: Ang dependency injection at ang mga modelo ng kahilingan ay ginagawang madali ang pagsusuri at pag-debug.

Mabilis na Pagsisimula sa FastAPI

1. Paghahanda ng Kapaligiran

Una, tiyaking naka-install ang Python 3.7 o mas mataas na bersyon. Pagkatapos, maaari mong gamitin ang sumusunod na utos upang i-install ang FastAPI at ang ASGI server na Uvicorn:

pip install fastapi uvicorn

2. Lumikha ng Pangunahing FastAPI Application

Susunod, lumikha ng isang simpleng FastAPI application. Sa iyong working directory, lumikha ng isang main.py na file, na may nilalaman na:

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. Patakbuhin ang Application

Gamitin ang Uvicorn upang patakbuhin ang FastAPI application:

uvicorn main:app --reload

Sa browser, bisitahin ang http://127.0.0.1:8000, makikita mo ang tugon na {"Hello": "World"}. Kasabay nito, ang pagbisita sa http://127.0.0.1:8000/items/1?q=test ay magbabalik ng {"item_id": 1, "query": "test"}.

4. Awtomatikong Pagbuo ng Dokumentasyon

Awtomatikong bumubuo ang FastAPI ng dokumentasyon para sa bawat ruta, maaari mong bisitahin ang sumusunod na URL upang makita ang interactive na dokumentasyon:

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

5. Mga Modelo ng Data at Pagpapatunay

Sinusuportahan din ng FastAPI ang paglikha ng mga modelo ng data gamit ang Pydantic para sa pagpapatunay ng body ng request. Halimbawa:

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

Ang nakaraang code snippet ay nagtatakda ng isang Item na modelo ng data, awtomatikong pinapatunayan ng FastAPI ang mga ipinasok na JSON data.

6. Asynchronous at Synchronous Programming

Sinusuportahan ng FastAPI ang asynchronous programming, maaari mong gamitin ang async def upang tukuyin ang mga asynchronous route function. Halimbawa:

import asyncio

@app.get("/wait/")
async def wait_for_response():
    await asyncio.sleep(1)
    return {"message": "Naghintay ng 1 segundo!"}

7. Pag-deploy ng FastAPI Application

Ang FastAPI application ay maaaring i-deploy sa iba't ibang mga kapaligiran, kabilang ang Docker, Kubernetes, mga cloud service, atbp. Narito ang isang simpleng halimbawa ng pag-deploy ng FastAPI gamit ang 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"]

Pagkatapos ay bumuo ng Docker image at patakbuhin:

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

Maaari mong bisitahin ang http://localhost:8000 upang makita ang iyong application.

Mga Pinakamahusay na Kasanayan

Gumamit ng Uri ng Pagsusuri: Palaging gumamit ng mga uri ng pagsusuri ng Python upang mapabuti ang readability at maintainability ng code.
Pagpapatunay ng Parameter: Magtakda ng angkop na pagpapatunay ng parameter batay sa mga kinakailangan ng negosyo, upang matiyak na ang data na ipinapasa sa API ay wasto.
Sentralisadong Paghawak ng Eksepsyon: Tukuyin ang pandaigdigang paghawak ng error upang matiyak na maayos na nahahawakan ng API ang mga eksepsyon.
Dokumentasyon at Komento: Panatilihing na-update ang dokumentasyon ng API, at panatilihing maa-access ang code sa pamamagitan ng mga komento at dokumentasyon.
Gumamit ng Middleware: Makatwirang gamitin ang middleware para sa mga function tulad ng Cross-Origin Resource Sharing (CORS), authentication, atbp.

Konklusyon

Bilang isang makapangyarihang tool para sa paggawa ng modernong mataas na pagganap na API, ang FastAPI ay malawak na tinatangkilik ng mga developer dahil sa pagiging epektibo at madaling gamitin. Mula sa mga baguhan hanggang sa mga may karanasang developer, lahat ay makikinabang dito. Sa aktwal na pagbuo, ang pagsasama ng mga pinakamahusay na kasanayan ay makakatulong sa iyo na mas mahusay na makabuo at mapanatili ang mga proyekto. Umaasa kami na ang gabay na ito ay makapagbibigay ng patnubay at tulong sa iyong pag-aaral ng FastAPI!