FastAPI

Ìlànà wẹ́ẹ́bù FastAPI, iṣẹ́ gíga, ó rọrùn láti kọ̀, o yára láti kóòdù, ó sì ṣetán fún iṣelọpọ ní lílo

Àkọsílẹ̀: https://fastapi.tiangolo.com

Orisun Kóòdù: https://github.com/tiangolo/fastapi

FastAPI jẹ́ ìgbàlódé, tí ó yára (iṣẹ-giga), ìlànà wẹ́ẹ́bù fún kikọ àwọn API pẹ̀lú Python 3.8+ èyí tí ó da lori àwọn ìtọ́kasí àmì irúfẹ́ Python.

Àwọn ẹya pàtàkì ni:

Ó yára: Iṣẹ tí ó ga púpọ̀, tí ó wa ni ibamu pẹ̀lú NodeJS àti Go (ọpẹ si Starlette àti Pydantic). Ọkan nínú àwọn ìlànà Python ti o yára jùlọ ti o wa.
Ó yára láti kóòdù: O mu iyara pọ si láti kọ àwọn ẹya tuntun kóòdù nipasẹ "Igba ìdá ọgọ́rùn-ún" (i.e. 200%) si "ọ̀ọ́dúrún ìdá ọgọ́rùn-ún" (i.e. 300%).
Àìtọ́ kékeré: O n din aṣiṣe ku bi ọgbon ìdá ọgọ́rùn-ún (i.e. 40%) ti eda eniyan (oṣiṣẹ kóòdù) fa. *
Ọgbọ́n àti ìmọ̀: Atilẹyin olootu nla. Ìparí nibi gbogbo. Àkókò díẹ̀ nipa wíwá ibi tí ìṣòro kóòdù wà.
Irọrun: A kọ kí ó le rọrun láti lo àti láti kọ ẹkọ nínú rè. Ó máa fún ọ ní àkókò díẹ̀ látı ka àkọsílẹ.
Ó kúkurú ní kikọ: Ó dín àtúnkọ àti àtúntò kóòdù kù. Ìkéde àṣàyàn kọ̀ọ̀kan nínú rẹ̀ ní ọ̀pọ̀lọpọ̀ àwọn ìlò. O ṣe iranlọwọ láti má ṣe ní ọ̀pọ̀lọpọ̀ àṣìṣe.
Ó lágbára: Ó ń ṣe àgbéjáde kóòdù tí ó ṣetán fún ìṣelọ́pọ̀. Pẹ̀lú àkọsílẹ̀ tí ó máa ṣàlàyé ara rẹ̀ fún ẹ ní ìbáṣepọ̀ aládàáṣiṣẹ́ pẹ̀lú rè.
Ajohunše/Ìtọ́kasí: Ó da lori (àti ibamu ni kikun pẹ̀lú) àwọn ìmọ ajohunše/ìtọ́kasí fún àwọn API: OpenAPI (èyí tí a mọ tẹlẹ si Swagger) àti JSON Schema.

* iṣiro yi da lori àwọn idanwo tí ẹgbẹ ìdàgbàsókè FastAPI ṣe, nígbàtí wọn kọ àwọn ohun elo iṣelọpọ kóòdù pẹ̀lú rẹ.

Àwọn onígbọ̀wọ́¶

Àwọn onígbọ̀wọ́ míràn

Àwọn ero àti èsì¶

"[...] Mò ń lo FastAPI púpọ̀ ní lẹ́nu àìpẹ́ yìí. [...] Mo n gbero láti lo o pẹ̀lú àwọn ẹgbẹ mi fún gbogbo iṣẹ ML wa ni Microsoft. Diẹ nínú wọn ni afikun ti ifilelẹ àwọn ẹya ara ti ọja Windows wa pẹ̀lú àwọn ti Office."

Kabir Khan - Microsoft (ref)

"A gba àwọn ohun èlò ìwé afọwọkọ FastAPI tí kò yí padà láti ṣẹ̀dá olùpín REST tí a lè béèrè lọ́wọ́ rẹ̀ láti gba àsọtẹ́lẹ̀. [fún Ludwig]"

Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - Uber (ref)

"Netflix ni inudidun láti kede itusilẹ orisun kóòdù ti ìlànà iṣọkan iṣakoso Ìṣòro wa: Ìfiránṣẹ́! [a kọ pẹ̀lú FastAPI]"

Kevin Glisson, Marc Vilanova, Forest Monsen - Netflix (ref)

"Inú mi dùn púpọ̀ nípa FastAPI. Ó mú inú ẹnì dùn púpọ̀!"

Brian Okken - Python Bytes podcast host (ref)

"Ní tòótọ́, ohun tí o kọ dára ó sì tún dán. Ní ọ̀pọ̀lọpọ̀ ọ̀nà, ohun tí mo fẹ́ kí Hug jẹ́ nìyẹn - ó wúni lórí gan-an láti rí ẹnìkan tí ó kọ́ nǹkan bí èyí."

Timothy Crosley - Hug creator (ref)

"Ti o ba n wa láti kọ ọkan ìlànà igbalode fún kikọ àwọn REST API, ṣayẹwo FastAPI [...] Ó yára, ó rọrùn láti lò, ó sì rọrùn láti kọ́[...]"

"A ti yipada si FastAPI fún APIs wa [...] Mo lérò pé wà á fẹ́ràn rẹ̀ [...]"

Ines Montani - Matthew Honnibal - Explosion AI founders - spaCy creators (ref) - (ref)

"Ti ẹnikẹni ba n wa láti kọ iṣelọpọ API pẹ̀lú Python, èmi yóò ṣe'dúró fún FastAPI. Ó jẹ́ ohun tí àgbékalẹ̀ rẹ̀ lẹ́wà, ó rọrùn láti lò àti wipe ó ni ìwọ̀n gíga, o tí dí bọtini paati nínú alakọkọ API ìdàgbàsókè kikọ fún wa, àti pe o ni ipa lori adaṣiṣẹ àti àwọn iṣẹ gẹ́gẹ́ bíi Onímọ̀-ẹ̀rọ TAC tí órí Íńtánẹ́ẹ̀tì"

Deon Pillsbury - Cisco (ref)

Typer, FastAPI ti CLIs¶

Ti o ba n kọ ohun èlò CLI láti ṣeé lọ nínú ohun èlò lori ebute kọmputa dipo API, ṣayẹwo Typer.

Typer jẹ́ àbúrò ìyá FastAPI kékeré. Àti pé wọ́n kọ́ láti jẹ́ FastAPI ti CLIs. ⌨️ 🚀

Èròjà¶

Python 3.8+

FastAPI dúró lórí àwọn èjìká tí àwọn òmíràn:

Starlette fún àwọn ẹ̀yà ayélujára.
Pydantic fún àwọn ẹ̀yà àkójọf'áyẹ̀wò.

Fifi sórí ẹrọ¶

$ pip install fastapi

---> 100%

Iwọ yóò tún nílò olupin ASGI, fún iṣelọpọ bii Uvicorn tabi Hypercorn.

$ pip install "uvicorn[standard]"

---> 100%

Àpẹẹrẹ¶

Ṣẹ̀dá rẹ̀¶

Ṣẹ̀dá fáìlì main.py (èyí tíí ṣe, akọkọ.py) pẹ̀lú:

from typing import Union

from fastapi import FastAPI

app = FastAPI()


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


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

Tàbí lò async def...

Tí kóòdù rẹ̀ bá ń lò async / await, lò async def:

from typing import Union

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: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

Akiyesi:

Tí o kò bá mọ̀, ṣàyẹ̀wò ibi tí a ti ní "In a hurry?" (i.e. "Ní kíákíá?") nípa async and await nínú àkọsílẹ̀.

Mu ṣiṣẹ¶

Mú olupin ṣiṣẹ pẹ̀lú:

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Nipa aṣẹ kóòdù náà uvicorn main:app --reload...

Àṣẹ uvicorn main:app ń tọ́ka sí:

main: fáìlì náà 'main.py' (Python "module").
app jẹ object( i.e. nǹkan) tí a ṣẹ̀dá nínú main.py pẹ̀lú ilà app = FastAPI().
--reload: èyí yóò jẹ́ ki olupin tún bẹ̀rẹ̀ lẹ́hìn àwọn àyípadà kóòdù. Jọ̀wọ́, ṣe èyí fún ìdàgbàsókè kóòdù nìkan, má ṣe é ṣe lori àgbéjáde kóòdù tabi fún iṣelọpọ kóòdù.

Ṣayẹwo rẹ¶

Ṣii aṣàwákiri kọ̀ǹpútà rẹ ni http://127.0.0.1:8000/items/5?q=somequery.

Ìwọ yóò sì rí ìdáhùn JSON bíi:

{"item_id": 5, "q": "somequery"}

O tí ṣẹ̀dá API èyí tí yóò:

Gbà àwọn ìbéèrè HTTP ni àwọn ipa ọ̀nà / àti /items/{item_id}.
Èyí tí àwọn ipa ọ̀nà (i.e. paths) méjèèjì gbà àwọn iṣẹ GET (a tun mọ si àwọn ọna HTTP).
Èyí tí ipa ọ̀nà (i.e. paths) /items/{item_id} ní àwọn ohun-ini ipa ọ̀nà tí ó yẹ kí ó jẹ́ int i.e. ÒǸKÀ.
Èyí tí ipa ọ̀nà (i.e. paths) /items/{item_id} ní àṣàyàn str àwọn ohun-ini (i.e. query parameter) q.

Ìbáṣepọ̀ àkọsílẹ̀ API¶

Ní báyìí, lọ sí http://127.0.0.1:8000/docs.

Lẹ́yìn náà, iwọ yóò rí ìdáhùn àkọsílẹ̀ API tí ó jẹ́ ìbáṣepọ̀ alaifọwọyi/aládàáṣiṣẹ́ (tí a pèṣè nípaṣẹ̀ Swagger UI):

Swagger UI

Ìdàkejì àkọsílẹ̀ API¶

Ní báyìí, lọ sí http://127.0.0.1:8000/redoc.

Wà á rí àwọn àkọsílẹ̀ aládàáṣiṣẹ́ mìíràn (tí a pese nipasẹ ReDoc):

ReDoc

Àpẹẹrẹ ìgbésókè mìíràn¶

Ní báyìí ṣe àtúnṣe fáìlì main.py láti gba kókó èsì láti inú ìbéèrè PUT.

Ní báyìí, ṣe ìkéde kókó èsì API nínú kóòdù rẹ nipa lílo àwọn ìtọ́kasí àmì irúfẹ́ Python, ọpẹ́ pàtàkìsi sí Pydantic.

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float
    is_offer: Union[bool, None] = None


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


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


@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
    return {"item_name": item.name, "item_id": item_id}

Olupin yóò tún ṣe àtúnṣe laifọwọyi/aládàáṣiṣẹ́ (nítorí wípé ó se àfikún -reload si àṣẹ kóòdù uvicorn lókè).

Ìbáṣepọ̀ ìgbésókè àkọsílẹ̀ API¶

Ní báyìí, lọ sí http://127.0.0.1:8000/docs.

Ìbáṣepọ̀ àkọsílẹ̀ API yóò ṣe imudojuiwọn àkọsílẹ̀ API laifọwọyi, pẹ̀lú kókó èsì ìdáhùn API tuntun:

Swagger UI

Tẹ bọtini "Gbiyanju rẹ" i.e. "Try it out", yóò gbà ọ́ láàyè láti jẹ́ kí ó tẹ́ àlàyé tí ó nílò kí ó le sọ̀rọ̀ tààrà pẹ̀lú API:

Swagger UI interaction

Lẹhinna tẹ bọtini "Ṣiṣe" i.e. "Execute", olùmúlò (i.e. user interface) yóò sọrọ pẹ̀lú API rẹ, yóò ṣe afiranṣẹ àwọn èròjà, pàápàá jùlọ yóò gba àwọn àbájáde yóò si ṣafihan wọn loju ìbòjú:

Swagger UI interaction

Ìdàkejì ìgbésókè àkọsílẹ̀ API¶

Ní báyìí, lọ sí http://127.0.0.1:8000/redoc.

Ìdàkejì àkọsílẹ̀ API yóò ṣ'afihan ìbéèrè èròjà/pàrámítà tuntun àti kókó èsì ti API:

ReDoc

Àtúnyẹ̀wò¶

Ni akopọ, ìwọ yóò kéde ni kete àwọn iru èròjà/pàrámítà, kókó èsì API, abbl (i.e. àti bẹbẹ lọ), bi àwọn èròjà iṣẹ.

O ṣe ìyẹn pẹ̀lú irúfẹ́ àmì ìtọ́kasí ìgbàlódé Python.

O ò nílò láti kọ́ síńtáàsì tuntun, ìlànà tàbí ọ̀wọ́ kíláàsì kan pàtó, abbl (i.e. àti bẹbẹ lọ).

Ìtọ́kasí Python 3.8+

Fún àpẹẹrẹ, fún int:

item_id: int

tàbí fún àwòṣe Item tí ó nira díẹ̀ síi:

item: Item

... àti pẹ̀lú ìkéde kan ṣoṣo yẹn ìwọ yóò gbà:

Atilẹyin olootu, pẹ̀lú:
- Pipari.
- Àyẹ̀wò irúfẹ́ àmì ìtọ́kasí.
Ìfọwọ́sí àkójọf'áyẹ̀wò (i.e. data):
- Aṣiṣe alaifọwọyi/aládàáṣiṣẹ́ àti aṣiṣe ti ó hàn kedere nígbàtí àwọn àkójọf'áyẹ̀wò (i.e. data) kò wulo tabi tí kò fẹsẹ̀ múlẹ̀.
- Ìfọwọ́sí fún ohun elo JSON tí ó jìn gan-an.
Ìyípadà tí input àkójọf'áyẹ̀wò: tí ó wà láti nẹtiwọọki si àkójọf'áyẹ̀wò àti irúfẹ́ àmì ìtọ́kasí Python. Ó ń ka láti:
- JSON.
- èròjà ọ̀nà tí ò gbé gbà.
- èròjà ìbéèrè.
- Àwọn Kúkì
- Àwọn Àkọlé
- Àwọn Fọọmu
- Àwọn Fáìlì
Ìyípadà èsì àkójọf'áyẹ̀wò: yíyípadà láti àkójọf'áyẹ̀wò àti irúfẹ́ àmì ìtọ́kasí Python si nẹtiwọọki (gẹ́gẹ́ bí JSON):
- Yí irúfẹ́ àmì ìtọ́kasí padà (str, int, float, bool, list, abbl i.e. àti bèbè ló).
- Àwọn ohun èlò datetime.
- Àwọn ohun èlò UUID.
- Àwọn awoṣẹ́ ibi ìpamọ́ àkójọf'áyẹ̀wò.
- ...àti ọ̀pọ̀lọpọ̀ díẹ̀ síi.
Ìbáṣepọ̀ àkọsílẹ̀ API aládàáṣiṣẹ́, pẹ̀lú ìdàkejì àgbékalẹ̀-àwọn-olùmúlò (i.e user interfaces) méjì:
- Àgbékalẹ̀-olùmúlò Swagger.
- ReDoc.

Nisinsin yi, tí ó padà sí àpẹẹrẹ ti tẹ́lẹ̀, FastAPI yóò:

Fọwọ́ sí i pé item_id wà nínú ọ̀nà ìbéèrè HTTP fún GET àti PUT.
Fọwọ́ sí i pé item_id jẹ́ irúfẹ́ àmì ìtọ́kasí int fún ìbéèrè HTTP GET àti PUT.
- Tí kìí bá ṣe bẹ, oníbàárà yóò ríi àṣìṣe tí ó wúlò, kedere.
Ṣàyẹ̀wò bóyá ìbéèrè àṣàyàn pàrámítà kan wà tí orúkọ rẹ̀ ń jẹ́ q (gẹ́gẹ́ bíi http://127.0.0.1:8000/items/foo?q=somequery) fún ìbéèrè HTTP GET.
- Bí wọ́n ṣe kéde pàrámítà q pẹ̀lú = None, ó jẹ́ àṣàyàn (i.e optional).
- Láìsí None yóò nílò (gẹ́gẹ́ bí kókó èsì ìbéèrè HTTP ṣe wà pẹ̀lú PUT).
Fún àwọn ìbéèrè HTTP PUT sí /items/{item_id}, kà kókó èsì ìbéèrè HTTP gẹ́gẹ́ bí JSON:
- Ṣàyẹ̀wò pé ó ní àbùdá tí ó nílò èyí tíí ṣe name i.e. orúkọ tí ó yẹ kí ó jẹ́ str.
- Ṣàyẹ̀wò pé ó ní àbùdá tí ó nílò èyí tíí ṣe price i.e. iye tí ó gbọ́dọ̀ jẹ́ float.
- Ṣàyẹ̀wò pé ó ní àbùdá àṣàyàn is_offer, tí ó yẹ kí ó jẹ́ bool, tí ó bá wà níbẹ̀.
- Gbogbo èyí yóò tún ṣiṣẹ́ fún àwọn ohun èlò JSON tí ó jìn gidi gan-an.
Yìí padà láti àti sí JSON lai fi ọwọ́ yi.
Ṣe àkọsílẹ̀ ohun gbogbo pẹ̀lú OpenAPI, èyí tí yóò wà ní lílo nípaṣẹ̀:
- Àwọn ètò àkọsílẹ̀ ìbáṣepọ̀.
- Aládàáṣiṣẹ́ oníbárà èlètò tíí ṣẹ̀dá kóòdù, fún ọ̀pọ̀lọpọ̀ àwọn èdè.
Pese àkọsílẹ̀ òní ìbáṣepọ̀ ti àwọn àgbékalẹ̀ ayélujára méjì tààrà.

A ń ṣẹ̀ṣẹ̀ ń mú ẹyẹ bọ́ làpò ní, ṣùgbọ́n ó ti ni òye bí gbogbo rẹ̀ ṣe ń ṣiṣẹ́.

Gbiyanju láti yí ìlà padà pẹ̀lú:

    return {"item_name": item.name, "item_id": item_id}

...láti:

        ... "item_name": item.name ...

...ṣí:

        ... "item_price": item.price ...

.. kí o sì wo bí olóòtú rẹ yóò ṣe parí àwọn àbùdá náà fúnra rẹ̀, yóò sì mọ irúfẹ́ wọn:

editor support

Fún àpẹẹrẹ pípé síi pẹ̀lú àwọn àbùdá mìíràn, wo Ìdánilẹ́kọ̀ọ́ - Ìtọ́sọ́nà Olùmúlò.

Itaniji gẹ́gẹ́ bí isọ'ye: ìdánilẹ́kọ̀ọ́ - itọsọna olùmúlò pẹ̀lú:

Ìkéde àṣàyàn pàrámítà láti àwọn oriṣiriṣi ibòmíràn gẹ́gẹ́ bíi: àwọn àkọlé èsì API, kúkì, ààyè fọọmu, àti fáìlì.
Bíi ó ṣe lé ṣètò àwọn ìdíwọ́ ìfọwọ́sí bí maximum_length tàbí regex.
Ó lágbára púpọ̀ ó sì rọrùn láti lo ètò Àfikún Ìgbẹ́kẹ̀lé Kóòdù.
Ààbò àti ìfọwọ́sowọ́pọ̀, pẹ̀lú àtìlẹ́yìn fún OAuth2 pẹ̀lú àmì JWT àti HTTP Ipilẹ ìfọwọ́sowọ́pọ̀.
Àwọn ìlànà ìlọsíwájú (ṣùgbọ́n tí ó rọrùn bákan náà) fún ìkéde àwọn àwòṣe JSON tó jinlẹ̀ (ọpẹ́ pàtàkìsi sí Pydantic).
Iṣọpọ GraphQL pẹ̀lú Strawberry àti àwọn ohun èlò ìwé kóòdù afọwọkọ mìíràn tí kò yí padà.
Ọpọlọpọ àwọn àfikún àwọn ẹ̀yà (ọpẹ́ pàtàkìsi sí Starlette) bí:
- WebSockets
- àwọn ìdánwò tí ó rọrùn púpọ̀ lórí HTTPX àti pytest
- CORS
- Cookie Sessions
- ...àti síwájú síi.

Ìṣesí¶

Àwọn àlá TechEmpower fi hàn pé FastAPI ń ṣiṣẹ́ lábẹ́ Uvicorn gẹ́gẹ́ bí ọ̀kan lára àwọn ìlànà Python tí ó yára jùlọ tí ó wà, ní ìsàlẹ̀ Starlette àti Uvicorn fúnra wọn (tí FastAPI ń lò fúnra rẹ̀). (*)

Láti ní òye síi nípa rẹ̀, wo abala àwọn Àlá.

Àṣàyàn Àwọn Àfikún Ìgbẹ́kẹ̀lé Kóòdù¶

Èyí tí Pydantic ń lò:

email_validator - fún ifọwọsi ímeèlì.
pydantic-settings - fún ètò ìsàkóso.
pydantic-extra-types - fún àfikún oríṣi láti lọ pẹ̀lú Pydantic.

Èyí tí Starlette ń lò:

httpx - Nílò tí ó bá fẹ́ láti lọ TestClient.
jinja2 - Nílò tí ó bá fẹ́ láti lọ iṣeto awoṣe aiyipada.
python-multipart - Nílò tí ó bá fẹ́ láti ṣe àtìlẹ́yìn fún "àyẹ̀wò" fọọmu, pẹ̀lú request.form().
itsdangerous - Nílò fún àtìlẹ́yìn SessionMiddleware.
pyyaml - Nílò fún àtìlẹ́yìn Starlette's SchemaGenerator (ó ṣe ṣe kí ó má nílò rẹ̀ fún FastAPI).
ujson - Nílò tí ó bá fẹ́ láti lọ UJSONResponse.

Èyí tí FastAPI / Starlette ń lò:

uvicorn - Fún olupin tí yóò sẹ́ àmúyẹ àti tí yóò ṣe ìpèsè fún iṣẹ́ rẹ tàbí ohun èlò rẹ.
orjson - Nílò tí ó bá fẹ́ láti lọ ORJSONResponse.

Ó lè fi gbogbo àwọn wọ̀nyí sórí ẹrọ pẹ̀lú pip install "fastapi[all]".

Iwe-aṣẹ¶

Iṣẹ́ yìí ni iwe-aṣẹ lábẹ́ àwọn òfin tí iwe-aṣẹ MIT.