Python je výkonný programovací jazyk. Má veľa knižníc na vytváranie rozhraní REST alebo RESTful API. Jednou z populárnych knižníc na vytváranie webových aplikácií a písanie rozhraní REST API je Banka.
V tomto článku vám ukážem, ako vytvoriť REST API v Pythone pomocou banky. Začnime.
Požiadavky:
Mal by si mať
- Vo vašom počítači je nainštalovaný Python 2 alebo Python 3.
- Vo vašom počítači je nainštalovaný program PIP alebo PIP3.
- Základné znalosti programovacieho jazyka Python.
- Základné pochopenie vykonávania príkazov v prostredí shell.
Mali by ste byť schopní nájsť články a návody na všetky tieto témy v systéme LinuxHint.com
V tomto článku budem používať Python 3 na Debiane 9 Stretch. Ak používate Python 2, budete sa musieť trochu prispôsobiť. Mali by ste byť schopní prísť na to sami, pretože to bude jednoduché ako písanie pytón namiesto python3 a pip namiesto pip3.
Nastavenie virtuálneho prostredia:
Zjednodušene povedané, virtuálne prostredie slúži na izoláciu jednej aplikácie Python od druhej. Balík Python, ktorý sa na to zvykne robiť, je virtualenv.
Môžete ľahko nainštalovať virtualenv pomocou PIP na vašom počítači pomocou nasledujúceho príkazu:
$ sudo -H pip3 nainštalovať virtualenvTeraz vytvorte adresár projektu (nazvime to) pyrest /) s nasledujúcim príkazom:
$ mkdir pyrestTeraz vytvorte virtuálne prostredie Pythonu na serveri pyrest / adresár projektu s nasledujúcim príkazom:
$ virtualenv pyrest /Teraz prejdite do adresára projektu pomocou nasledujúceho príkazu:
$ cd pyrestPotom aktivujte virtuálne prostredie Pythonu nasledujúcim príkazom:
$ zdrojový kôš / aktivovaťNakoniec spustite nasledujúci príkaz na inštaláciu knižnice Flask Python:
$ bin / pip3 inštalačná bankaPísanie prvého scenára banky:
V tejto časti napíšem program ahoj do sveta v Python Flask.
Najskôr vytvorte súbor Ahoj.py vo vašom adresári projektu:
$ touch ahoj.pyTeraz pridajte nasledujúce riadky do Ahoj.py súbor a uložte ho.
V nasledujúcej časti vám ukážem, ako spustiť skripty Flask.
Spustený skript banky:
Teraz začnite Ahoj.py Bankový server, spustite nasledujúci príkaz:
$ bin / python3 ahoj.pyAko vidíte, server sa spustil dňa http: // 127.0.0.1: 8080.
Teraz máte prístup k serveru Flask http: // 127.0.0.1: 8080 z webového prehliadača alebo softvérov na testovanie API, ako je Postman. Budem používať CURL.
$ curl http: // 127.0.0.1: 8080Ako vidíte, správny výstup sa vytlačí na obrazovku.
Gratulujem! Banka funguje.
Prístup k údajom pomocou nástroja GET v rozhraní REST API:
Žiadosť GET na rozhraní REST API sa používa na načítanie informácií zo servera API. Nastavíte niektoré koncové body API a v danom koncovom bode urobíte požiadavku GET. Je to jednoduché.
Najskôr vytvorte nový súbor dostať.py v adresári projektu pomocou nasledujúceho príkazu:
$ touch dostať.pyTeraz pridajte do svojej nasledujúce riadky dostať.py súbor a uložte ho.
Tu, na riadku 1, Banka funkcia konštruktora a jsonify funkcia je importovaná z banky.
Na linke 3, a Banka objekt je vytvorený a uložený na aplikácia premenná.
Na riadku 5 som vytvoril pole Pythonu slovníkov niektorých fiktívnych údajov a uložil som ich do účtov premenná.
Na riadku 10 som definoval koncový bod API / účty a metóda žiadosti, ktorá je ZÍSKAJTE.
Na riadku 11 som definoval funkciu getAccounts (). getAccounts () funkcia sa vykoná, keď GET požiadavku na / účty koncový bod je urobený.
Riadok 12, ktorý je súčasťou getAccounts () funkcia, konvertoval som účtov pole slovníkov pomocou JSON jsonify () funkciu a vrátil ju.
Na linku 14-15 som zavolal na aplikácia.run () povedať banke, aby spustila server API na porte 8080.
Teraz spustite server Flask API pomocou nasledujúceho príkazu:
$ bin / python3 get.pyServer sa spustil na porte 8080.
Teraz pošlite žiadosť GET na server / účty koncový bod s CURL takto:
$ curl http: // 127.0.0.1: 8080 / účtyAko vidíte, údaje o účtoch sa na žiadosť GET zobrazia vo formáte JSON / účty koncový bod.
Môžete tiež získať konkrétne údaje o účte. Za týmto účelom vytvorím ďalší koncový bod API / účet /
Upravte dostať.py skript a pridajte doň označené riadky.
Tu, na riadku 14, som definoval koncový bod API / účet /
Na riadku 15-17 funkcia getAccount () pre koncový bod API / účet /
Na linke 16 premáva id premenná sa prevedie na celé číslo. Tiež som vyvodil 1 z id premenná. Pretože index poľa začína od 0. Chcem spustiť ID účtu od 1. Ak teda dám 1 účet
V riadku 17 pole v indexe
Zvyšok kódov je rovnaký.
Teraz znova spustite server API.
$ bin / python3 get.py
Údaje pre účet 1 a 2 som požadoval osobitne a získal som očakávaný výstup, ako vidíte na snímke obrazovky nižšie.
$ curl http: // 127.0.0.1: 8080 / účet / 1$ curl http: // 127.0.0.1: 8080 / účet / 2
Pridávanie údajov pomocou POST v rozhraní REST API:
Teraz sa chystám premenovať dostať.py do api.py a pridať koncový bod API / účet pre pridanie nových údajov.
Premenovať dostať.py do api.py:
$ mv -v dostať.py api.pyNajskôr pridajte riadky (19-26), ako sú označené na obrázku nižšie, do api.py spis.
Teraz spustite api.py server:
$ bin / python3 api.py
Ak chcete vložiť nové údaje do / účet koncový bod, spustite nasledujúci príkaz:
$ curl -X POST -H "Content-Type: application / json" -d '"name": "Shovon", "balance": 100'http: // 127.0.0.1: 8080 / účet
POZNÁMKA: Tu, „„ Name “:„ Shovon “,„ balance “: 100 ' sú vstupné údaje JSON.
Mali by sa vložiť údaje.
Ako vidíte, nové údaje sú pridané.
Takže to je pre tento článok všetko. Ďakujeme, že ste si prečítali tento článok.