REST ehk representational State Transfer on tarkvaraarendusstiil, mida kasutatakse peamiselt API või rakenduste programmeerimisliidese kujundamisel interaktiivsete ja kaasaegsete veebiteenuste loomiseks. Seda tuntakse ka kui RESTful veebiteenust.

Python on võimas programmeerimiskeel. Selles on palju teeke REST või RESTful API-de loomiseks. Üks populaarsemaid raamatukogusid veebirakenduste loomiseks ja REST API-de kirjutamiseks on Kolb.

Selles artiklis näitan teile, kuidas luua kolvi abil Pythonis REST API. Alustame.

Nõuded:

Sa peaksid olema

• Teie arvutisse on installitud Python 2 või Python 3.
• Arvutisse installitud PIP või PIP3.
• Põhiteadmised Pythoni programmeerimiskeelest.
• Põhiline arusaam shellis käskude täitmisest.

LinuxHintist peaksite saama leida artikleid ja õpetusi kõigi nende teemade kohta.com

Selles artiklis kasutan Debian 9 Stretchil Python 3-d. Kui kasutate Python 2, peate natuke kohandama. Peaksite selle ise välja mõtlema, sest see on lihtne nagu kirjutamine püüton selle asemel python3 ja pip selle asemel pip3.

Virtuaalse keskkonna seadistamine:

Lihtsustatult öeldes kasutatakse virtuaalset keskkonda ühe Pythoni rakenduse eraldamiseks teisest. Selleks kasutati Pythoni paketti virtualenv.

Saate hõlpsasti installida virtualenv kasutades oma arvutis PIP-d järgmise käsuga:

$ sudo -H pip3 installib virtualenv

Nüüd looge projekti kataloog (nimetame seda pyrest /) järgmise käsuga:

$ mkdir pyrest

Nüüd looge saidil Python virtuaalne keskkond pyrest / projekti kataloog järgmise käsuga:

$ virtualenv pyrest /

Nüüd navigeerige projekti kataloogi järgmise käsuga:

$ cd pyrest

Seejärel aktiveerige Pythoni virtuaalne keskkond järgmise käsuga:

$ source bin / aktiveeri

Lõpuks käivitage Flask Pythoni teegi installimiseks järgmine käsk:

$ bin / pip3 paigalduskolb

Esimese kolbi skripti kirjutamine:

Selles osas kirjutan tere maailmaprogrammi Pythoni kolvis.

Kõigepealt looge fail Tere.py oma projekti kataloogis:

$ touch tere.py

Nüüd lisage saidile järgmised read Tere.py fail ja salvestage see.

Järgmises jaotises näitan teile, kuidas Flaski skripte käivitada.

Kolbi skripti käitamine:

Nüüd alustage Tere.py Kolviserver, käivitage järgmine käsk:

tere $ bin / python3.py

Nagu näete, on server käivitanud http: // 127.0.0.1: 8080.

Nüüd saate pääseda Flaski serverile http: // 127.0.0.1: 8080 veebibrauserist või API testimistarkvaradest, näiteks Postman. Ma hakkan kasutama CURL-i.

$ curl http: // 127.0.0.1: 8080

Nagu näete, prinditakse ekraanile õige väljund.

Palju õnne! Kolb töötab.

Andmetele juurdepääs REST API-s GET-i abil:

GET päringut REST API-l kasutatakse teabe hankimiseks API serverist. Te määrate mõned API lõpp-punktid ja teete selle lõpp-punkti jaoks GET-päringu. See on lihtne.

Kõigepealt looge uus fail saada.py oma projekti kataloogis järgmise käsuga:

$ touch saada.py

Nüüd lisage oma rida järgmised read saada.py fail ja salvestage see.

Siin, 1. real, on Kolb konstruktori funktsioon ja jsonify funktsioon imporditakse kolbi moodulist.

3. liinil a Kolb objekt luuakse ja sellele salvestatakse rakendus muutuv.

5. Real lõin Pythoni massiivi teatavate mannekeenide sõnaraamatutest ja salvestasin need kontod muutuv.

Real 10 määratlesin API lõpp-punkti / kontod ja päringumeetod, mis on Hangi.

11. real määratlesin funktsiooni getAccounts (). getAccounts () funktsioon käivitatakse, kui GET taotlus / kontod lõpp-punkt on tehtud.

Rida 12, mis on osa getAccounts () funktsiooni teisendasin kontod sõnastik JSONile, kasutades jsonify () funktsiooni ja tagastas selle.

Liinil 14-15 helistasin rakendus.jooksma () käskida Kolbil API serveri käivitamist pordis 8080.

Nüüd käivitage Flask API server järgmise käsuga:

$ bin / python3 get.py

Server on alanud porti 8080.

Esitage nüüd GET-taotlus / kontod tulemus CURL-iga järgmiselt:

$ curl http: // 127.0.0.1: 8080 / kontod

Nagu näete, kuvatakse kontode andmed GET-päringus JSON-vormingus / kontod lõpp-punkt.

Samuti saate hankida konkreetseid kontoandmeid. Selleks kavatsen luua veel ühe API lõpp-punkti /konto/. Siin, on kontoomaniku ID. ID on siin massiivi indeks.

Redigeerige saada.py skripti ja lisage sellele märgitud read.

Siin real 14 määratlesin API lõpp-punkti /konto/ ja kasutatav meetod, mis on Hangi.

Reas 15-17 funktsioon getAccount () API lõpp-punkti jaoks /konto/ on määratletud. The getAccount () funktsioon aktsepteerib a id argumendina. Väärtus alates API lõpp-punktist on seatud id muutuja getAccount () funktsioon.

16. real on id muutuja teisendatakse täisarvuks. Järeldasin ka 1 id muutuv. Kuna massiivi indeks algab 0-st. Soovin alustada konto ID-d 1-st. Nii et kui panen kontoks 1 , 1 - 1 = 0, ma saan massiivi elemendi indeksist 0 kontod.

17. real massiiv indeksis tagastatakse kui JSON.

Ülejäänud koodid on samad.

Nüüd käivitage API server uuesti.

$ bin / python3 get.py

Taotlesin andmeid kontode 1 ja 2 kohta eraldi ja sain oodatud väljundi, nagu näete allolevalt ekraanipildilt.

$ curl http: // 127.0.0.1: 8080 / konto / 1
$ curl http: // 127.0.0.1: 8080 / konto / 2

Andmete lisamine REST API-s POST-i abil:

Nüüd nimetan nime ümber saada.py kuni api.py ja lisage API lõpp-punkt /konto uute andmete lisamiseks.

Nimeta ümber saada.py kuni api.py:

$ mv -v saada.py api.py

Kõigepealt lisage joonele (19–26) alloleval ekraanipildil märgitud read api.py faili.

Nüüd käivitage api.py server:

$ bin / python3 api.py

Uute andmete sisestamiseks /konto lõpp-punkt, käivitage järgmine käsk:

$ curl -X POST -H "Content-Type: application / json" -d '"name": "Shovon", "balance": 100'
http: // 127.0.0.1: 8080 / konto

MÄRGE: Siin, '"Nimi": "Shovon", "saldo": 100' on JSON-i sisendandmed.

Andmed tuleks sisestada.

Nagu näete, lisatakse uued andmed.

Nii et see on selle artikli jaoks.  Täname selle artikli lugemise eest.