Erstellen von REST -API in Python

Erstellen von REST -API in Python
REST- oder Repräsentationsstatustransfer ist ein Softwareentwicklungsstil. Es ist auch als erholsamer Webdienst bekannt.

Python ist eine leistungsstarke Programmiersprache. Es hat viele Bibliotheken zum Aufbau von Ruhe oder Rückenläufen APIs. Eine der beliebten Bibliothek zum Erstellen von Web -Apps und zum Schreiben von REST -APIs ist Flasche.

In diesem Artikel werde ich Ihnen zeigen, wie Sie in Python mit Flask REST API erstellen können. Lass uns anfangen.

Anforderungen:

Du solltest haben

  • Python 2 oder Python 3 auf Ihrem Computer installiert.
  • PIP oder PIP3 auf Ihrem Computer installiert.
  • Das grundlegende Verständnis der Python -Programmiersprache.
  • Das grundlegende Verständnis der Ausführung von Befehlen in der Shell.

Sie sollten in der Lage sein, Artikel und Tutorials zu all diesen Themen unter LinuxHint zu finden.com

Ich werde Python 3 in diesem Artikel auf Debian 9 Stretch verwenden. Wenn Sie Python 2 verwenden, müssen Sie sich ein wenig anpassen. Sie sollten in der Lage sein, es selbst herauszufinden, da es einfach ist wie das Schreiben Python anstatt Python3 Und Pip anstatt PIP3.

Einrichten der virtuellen Umgebung:

Einfach ausgedrückt, die virtuelle Umgebung wird verwendet, um eine Python -App von einer anderen zu isolieren. Das Python -Paket, das dies verwendet hat virtualenv.

Sie können einfach installieren virtualenv Verwenden Sie PIP auf Ihrem Computer mit dem folgenden Befehl:

$ sudo -h pip3 install virualenv installieren

Erstellen Sie nun ein Projektverzeichnis (nennen wir es es Pyrest/) mit dem folgenden Befehl:

$ mkdir pyrest

Erstellen Sie nun eine virtuelle Python -Umgebung auf der Pyrest/ Projektverzeichnis mit dem folgenden Befehl:

$ virtualenv pyrest/

Navigieren Sie nun mit dem folgenden Befehl in das Projektverzeichnis:

$ CD Pyrest

Aktivieren Sie dann die virtuelle Python -Umgebung mit dem folgenden Befehl:

$ Source Bin/aktivieren

Führen Sie schließlich den folgenden Befehl aus, um die Flask Python Library zu installieren:

$ bin/pip3 -Kolben installieren

Schreiben Sie Ihr erstes Flask -Skript:

In diesem Abschnitt werde ich ein Hello World -Programm in Python Flask schreiben.

Erstellen Sie zunächst eine Datei Hallo.py In Ihrem Projektverzeichnis:

$ touch Hallo.py

Fügen Sie nun die folgenden Zeilen hinzu zu Hallo.py Datei und speichern.

Im nächsten Abschnitt werde ich Ihnen zeigen, wie Sie Flask -Skripte ausführen können.

STRAFT SCHRIFT FÜR SCHRIFT:

Nun, um die zu starten Hallo.py Flask Server, den folgenden Befehl ausführen:

$ bin/python3 Hallo.py

Wie Sie sehen können, hat der Server begonnen http: // 127.0.0.1: 8080.

Jetzt können Sie auf den Flask -Server zugreifen http: // 127.0.0.1: 8080 Aus dem Webbrowser oder API -Testen von Software wie Postman. Ich werde Curl verwenden.

$ curl http: // 127.0.0.1: 8080

Wie Sie sehen können, wird die richtige Ausgabe auf dem Bildschirm gedruckt.

Herzlichen Glückwunsch! Flask funktioniert.

Zugriff auf Daten mit der GET -REST -API:

Nehmen Sie die Anfrage auf REST -API ab, um Informationen vom API -Server abzurufen. Sie setzen einige API -Endpunkte und stellen an diesem Endpunkt eine Get -Anfrage durch. Es ist einfach.

Erstellen Sie zunächst eine neue Datei erhalten.py In Ihrem Projektverzeichnis mit dem folgenden Befehl:

$ touch bekommen.py

Fügen Sie nun die folgenden Zeilen in Ihre hinzu erhalten.py Datei und speichern.

Hier in Zeile 1 die Flasche Konstruktorfunktion und Jsonify Die Funktion wird aus dem Flask -Modul importiert.

In Zeile 3, a Flasche Objekt wird erstellt und aufbewahrt App Variable.

In Zeile 5 habe ich eine Python -Reihe von Wörterbüchern einiger Dummy -Daten erstellt und sie in der gespeichert Konten Variable.

In Zeile 10 habe ich den API -Endpunkt definiert /Konten und die Anforderungsmethode, nämlich ERHALTEN.

In Zeile 11 habe ich die Funktion definiert GetAccounts (). GetAccounts () Die Funktion wird ausgeführt, wenn eine GET -Anfrage zu erhalten /Konten Endpunkt wird gemacht.

Zeile 12, der Teil von ist GetAccounts () Funktion, ich habe die konvertiert Konten Reihe von Wörterbüchern an JSON mithilfe Jsonify () Funktion und zurückgegeben.

In Zeile 14-15 rief ich das an App.laufen() Flask zur Ausführung des API -Servers auf dem Port ausführen 8080.

Führen Sie nun den Flask -API -Server mit dem folgenden Befehl aus:

$ bin/python3 bekommen.py

Der Server hat mit Port 8080 begonnen.

Machen Sie nun eine Anfrage an die /Konten Endpunkt mit Curl wie folgt:

$ curl http: // 127.0.0.1: 8080/Konten

Wie Sie sehen können /Konten Endpunkt.

Sie können auch bestimmte Kontodaten erhalten. Dazu werde ich einen weiteren API -Endpunkt erstellen /Konto/. Hier, wird die ID der Kontoinhaber sein. Die ID hier ist der Index des Arrays.

Bearbeiten die erhalten.py Skript und fügen Sie die markierten Zeilen hinzu.

Hier in Zeile 14 habe ich den API -Endpunkt definiert /Konto/ und die zu verwendende Methode, das ist ERHALTEN.

In Zeile 15-17 die Funktion GetAccount () Für den API -Endpunkt /Konto/ ist definiert. Der GetAccount () Funktion akzeptiert a Ausweis als Argument. Der Wert von Aus dem API -Endpunkt wird auf die festgelegt Ausweis Variable von GetAccount () Funktion.

In Zeile 16 die Ausweis Variable wird in eine Ganzzahl umgewandelt. Ich habe auch 1 von der abgeleitet Ausweis Variable. Weil der Array -Index von 0 beginnt. Ich möchte die Konto -ID von 1 starten. Also, wenn ich 1 als Konto lege , 1 - 1 = 0, ich erhalte das Element am Index 0 aus dem Array Konten.

In Zeile 17 das Array am Index wird als JSON zurückgegeben.

Der Rest der Codes ist gleich.

Führen Sie nun den API -Server erneut aus.

$ bin/python3 bekommen.py

Ich habe Daten für Konto 1 und 2 getrennt angefordert und habe die erwartete Ausgabe erhalten, wie Sie aus dem Screenshot unten sehen können.

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

Hinzufügen von Daten mit dem Beitrag in der REST -API:

Jetzt werde ich umbenennen erhalten.py Zu API.py und fügen Sie einen API -Endpunkt hinzu /Konto zum Hinzufügen neuer Daten.

Umbenennen erhalten.py Zu API.py:

$ mv -v bekommen.PY API.py

Fügen Sie zunächst die Linien (19-26) hinzu, wie im Screenshot unten zu dem markiert API.py Datei.

Jetzt laufen API.py Server:

$ bin/python3 api.py

Neue Daten in die einfügen /Konto Endpunkt führen Sie den folgenden Befehl aus:

$ curl -x post -h "content -type: application/json" -d '"name": "shovon", "balance": 100'
http: // 127.0.0.1: 8080/Konto

NOTIZ: Hier, '"Name": "Shovon", "Balance": 100' Ist die JSON -Eingabedaten.

Die Daten sollten eingefügt werden.

Wie Sie sehen können, werden die neuen Daten hinzugefügt.

Das war es für diesen Artikel. Danke, dass du diesen Artikel gelesen hast.