Piton

REST API létrehozása Pythonban

REST API létrehozása Pythonban
A REST vagy a reprezentatív állapotátvitel egy szoftverfejlesztési stílus, amelyet főleg az API vagy az alkalmazásprogramozási felület tervezése során használnak interaktív és modern webszolgáltatások építéséhez. RESTful webszolgáltatás néven is ismert.

A Python egy hatékony programozási nyelv. Sok könyvtárral rendelkezik a REST vagy a RESTful API-k építéséhez. A webalkalmazások építéséhez és a REST API-k írásához az egyik népszerű könyvtár Lombik.

Ebben a cikkben megmutatom, hogyan hozhat létre REST API-t Python-ban a Lombik segítségével. Kezdjük el.

Követelmények:

Neked kellene

Tudnia kell cikkeket és oktatóanyagokat találni ezekről a témákról a LinuxHint-en.com

Ebben a cikkben a Python 3-at fogom használni a Debian 9 Stretch-en. Ha Python 2-t használ, akkor kicsit módosítania kell. Önnek ki kell tudnia találni, mivel egyszerű lesz, mint az írás piton ahelyett python3 és csipog ahelyett pip3.

Virtuális környezet beállítása:

Leegyszerűsítve: a virtuális környezetet használják az egyik Python alkalmazás elkülönítésére a másiktól. A Python csomag ezt használta virtualenv.

Könnyen telepíthető virtualenv a számítógépén lévő PIP használatával a következő paranccsal:

$ sudo -H pip3 telepítse a virtualenv-t

Most hozzon létre egy projekt könyvtárat (nevezzük pirest /) a következő paranccsal:

$ mkdir pyrest

Most hozzon létre egy Python virtuális környezetet a pirest / projektkönyvtár a következő paranccsal:

$ virtualenv pyrest /

Most lépjen a projekt könyvtárba a következő paranccsal:

$ cd pirest

Ezután aktiválja a Python virtuális környezetet a következő paranccsal:

$ source bin / activ

Végül futtassa a következő parancsot a Flask Python könyvtár telepítéséhez:

$ bin / pip3 telepítő lombik

Az első lombik parancsfájljának megírása:

Ebben a részben írok egy hello world programot Python Lombikban.

Először hozzon létre egy fájlt Helló.py a projekt könyvtárban:

$ touch hello.py

Most adja hozzá a következő sorokat ehhez: Helló.py fájlt, és mentse el.

A következő részben megmutatom, hogyan kell futtatni a Lombik parancsfájlokat.

Lombik parancsfájl futtatása:

Most kezdjem a Helló.py Lombikkiszolgáló, futtassa a következő parancsot:

$ bin / python3 hello.py

Amint láthatja, a szerver elindult http: // 127.0.0.1: 8080.

Most elérheti a Lombik szervert http: // 127.0.0.1: 8080 a webböngészőből vagy az API tesztelő szoftverekből, például a Postmanból. A CURL-t fogom használni.

$ curl http: // 127.0.0.1: 8080

Mint látható, a megfelelő kimenetet nyomtatja a képernyő.

gratula! Lombik dolgozik.

Adatokhoz való hozzáférés a GET használatával a REST API-ban:

A GET kérés a REST API-n információt használ az API szerverről. Beállít néhány API-végpontot, és GET-kérést hajt végre ezen a végponton. Ez egyszerű.

Először hozzon létre egy új fájlt kap.py a projekt könyvtárban a következő paranccsal:

$ touch get.py

Most adja hozzá a következő sorokat a kap.py fájlt, és mentse el.

Itt, az 1. vonalon, a Lombik konstruktor funkció és jsonify funkció importálva van a lombik modulból.

A 3. vonalon a Lombik objektum létrehozása és tárolása kb változó.

Az 5-ös vonalon létrehoztam egy Python tömböt néhány próbabábu szótárából, és a fiókok változó.

A 10. vonalon definiáltam az API végpontot /fiókok és a kérési módszer, amely KAP.

A 11. vonalon definiáltam a függvényt getAccounts (). getAccounts () függvény akkor fog végrehajtani, amikor egy GET kérést küld a /fiókok végpont készül.

12. vonal, amely része getAccounts () függvényt, átalakítottam a fiókok szótárak tömbje a JSON-hoz a jsonify () funkciót adta vissza.

A 14-15-ös vonalon felhívtam a kb.fuss() hogy utasítsam a lombikot, hogy futtassa az API szervert a porton 8080.

Most futtassa a Flask API kiszolgálót a következő paranccsal:

$ bin / python3 get.py

A szerver elindult a 8080-as porton.

Most kérjen GET kérést a /fiókok CURL végpont a következőképpen:

$ curl http: // 127.0.0.1: 8080 / számlák

Amint láthatja, a fiókok adatai JSON formátumban jelennek meg a GET kéréskor /fiókok végpont.

Konkrét számlaadatokat is beszerezhet. Ehhez egy másik API-végpontot fogok létrehozni / account /. Itt, lesz a számlatulajdonos azonosítója. Az ID itt a tömb indexe.

Szerkessze a kap.py szkriptet, és adja hozzá a megjelölt sorokat.

Itt a 14. vonalon definiáltam az API végpontot / account / és az alkalmazandó módszert, amely KAP.

A 15-17-es vonalon a függvény getAccount () az API végponthoz / account / meg van határozva. A getAccount () függvény elfogadja a id érvként. Az értéke az API-végponttól a id változója getAccount () funkció.

A 16-os vonalon a id változót egész számra konvertáljuk. Az 1-ből is levontam id változó. Mivel a tömbindex 0-tól kezdődik. 1-től szeretném elindítani a fiók azonosítóját. Tehát ha 1-et teszek számlának , 1 - 1 = 0, a tömbből kapom az elemet a 0 indexben fiókok.

A 17. sorban az index tömbje JSON néven kerül visszaadásra.

A többi kód megegyezik.

Most futtassa újra az API-kiszolgálót.

$ bin / python3 get.py

Külön kértem az 1. és 2. számla adatait, és megkaptam a várt kimenetet, amint az az alábbi képernyőképen látható.

$ curl http: // 127.0.0.1: 8080 / számla / 1
$ curl http: // 127.0.0.1: 8080 / számla / 2

Adatok hozzáadása a POST használatával a REST API-ban:

Most át fogom nevezni kap.py nak nek api.py és adjon hozzá egy API-végpontot / account új adatok hozzáadásához.

Átnevezés kap.py nak nek api.py:

$ mv -v get.py api.py

Először adja hozzá a sorokat (19-26) az alábbi képernyőképen látható módon a sorhoz api.py fájl.

Most futtassa a api.py szerver:

$ bin / python3 api.py

Új adatok beszúrása a / account futtassa a következő parancsot:

$ curl -X POST -H "Tartalom-típus: application / json" -d '"name": "Shovon", "balance": 100'
http: // 127.0.0.1: 8080 / számla

JEGYZET: Itt, '"Név": "Shovon", "egyensúly": 100' a JSON bemeneti adat.

Az adatokat be kell illeszteni.

Amint láthatja, az új adatok hozzáadódnak.

Tehát ez a cikk.  Köszönjük, hogy elolvasta ezt a cikket.

Az 5 legjobb játékrögzítő kártya
Mindannyian láttuk és szerettük a YouTube-on a streaming játékokat. A PewDiePie, a Jakesepticye és a Markiplier csak néhány a legnépszerűbb játékosok ...
Hogyan lehet játékot fejleszteni Linuxon
Egy évtizeddel ezelőtt nem sok Linux-felhasználó jósolta, hogy kedvenc operációs rendszerük egy napon a videojátékok népszerű játékplatformja lesz. El...
Kereskedelmi játékmotorok nyílt forráskódú portjai
Ingyenes, nyílt forráskódú és platformokon átívelő játékmotorok szabadidős programjai felhasználhatók a régi, valamint a meglehetősen friss játékcímek...