Arbeiten mit APIs in Python: Ein praktischer Leitfaden

Auszug:
„APIs machen Softwareanwendungen modular. Sie beschleunigen die Softwareentwicklungszeit.“

Application Programming Interface (oder API) ist eine abstrahierte Schicht, die die Kommunikation zwischen verschiedenen Softwareanwendungen und -komponenten ermöglicht. Wie kommt es zu dieser Kommunikation? Web-APIs, auf die wir uns in diesem Artikel konzentrieren werden, befinden sich zwischen einer Softwareanwendung, die von einem Client verwendet wird, und der Datenbank, in der die Informationen gespeichert sind. Lesen Sie hier mehr über die verschiedenen Arten von APIs. Die Kommunikation erfolgt unabhängig von der Programmiersprache, in der die einzelnen Softwareanwendungen geschrieben sind; ob Python, Java, JavaScript usw. Vorausgesetzt, die von den Softwareanwendungen an die API gesendete Anfrage ist gültig, sei es ein Abruf-, Aktualisierungs-, Lösch- oder Erstellungsvorgang.

Stellen Sie sich eine Social-Media-Plattform wie Instagram vor, auf der ein bestimmter Benutzer ein Bild postet. Was intern passiert, ist, dass der Benutzer eine POST-Anfrage an den vorgeschriebenen Instagram-API-Endpunkt stellt. Senden eines Bildes an die Datenbank. Ein anderer Benutzer kann den Beitrag sehen, indem er beim Scrollen auf der Timeline eine GET-Anfrage an die API stellt, ohne es überhaupt zu wissen. Sie sehen, dass dort Kommunikation stattfindet – über die API.

Dies kann auch dann der Fall sein, wenn die beiden Benutzer über die API mit Softwareanwendungen kommunizieren, die in unterschiedlichen Sprachen geschrieben sind.
Die Abbildung unten zeigt zwei unterschiedliche Softwareanwendungen, die über eine API kommunizieren.

Foto vom Autor

Darüber hinaus machen APIs Softwareanwendungen modular. Sie beschleunigen die Softwareentwicklungszeit. Modular in dem Sinne, dass die API-Implementierung von unserer Codebasis getrennt ist, wir müssen lediglich Aufrufe an die API tätigen. Es beschleunigt die Entwicklungszeit, da wir keinen Code schreiben müssen, der ähnliche Funktionen bereitstellt wie die API von Grund auf, wir müssen ihn nur aufrufen.

In diesem Artikel erfahren Sie, wie Sie eine öffentlich verfügbare API mit Python nutzen. Bleiben Sie dran.

Voraussetzungen

Dieser Artikel eignet sich für Python-Programmierer auf Anfängerniveau, die ihr Verständnis von APIs durch eine spezifische Implementierung in Python erweitern möchten.
Stellen Sie zum Üben sicher, dass Ihr Gerät mit dem Internet verbunden ist.

Dieser Artikel dient auch als Auffrischung für erfahrenere Python-Entwickler.

Ziele

Wenn Sie bis zum Ende dieses Artikels durchgehen, sollten Sie:
Erfahren Sie mehr über die Requests-Bibliothek in Python.
Erfahren Sie, wie Sie GET-, PUT-, PATCH-, DELETE- und POST-Anfragen stellen.
Erfahren Sie, wie Sie die von einem API-Aufruf empfangenen Daten in Ihrem Code speichern und nutzen.

Die Anforderungsbibliothek verstehen

requests ist laut Pypi eines der am häufigsten heruntergeladenen Python-Pakete mit etwa 30 Millionen Downloads pro Woche. Es ermöglicht Ihnen das einfache Senden von HTTP-Anfragen in Python. Anfragen ist ein getestetes und vertrauenswürdiges Python-Paket, das von vielen etablierten Marken wie IBM verwendet wird. Den Quellcode finden Sie hier.
Einige der „geliebten“ Funktionen von Anfragen sind:

• Keep-Alive und Verbindungspooling

• Internationale Domains und URLs

• Sitzungen mit Cookie-Persistenz

• SSL-Überprüfung im Browser-Stil

• Automatische Inhaltsdekodierung

• Basis-/Digest-Authentifizierung

• Elegante Schlüssel-/Wert-Cookies

• Automatische Dekomprimierung

• Unicode-Antwortkörper

• HTTP(S)-Proxy-Unterstützung

• Mehrteilige Datei-Uploads

• Streaming-Downloads

• Verbindungs-Timeouts

• Chunkierte Anfragen

• .netrc-Support

Erste Schritte mit Anfragen

Ich gehe davon aus, dass Sie Python bereits auf Ihrem Computer installiert haben. Installieren Sie das Anforderungspaket, indem Sie die folgenden Anweisungen befolgen:
Öffnen Sie unter Linux oder Mac OS Ihr Terminal und führen Sie Folgendes aus:

python3 -m pip install requests

Unter Windows gehen Sie wie folgt vor:

python -m pip install requests

Dadurch wird das Paket Anfragen auf Ihren Computer heruntergeladen.

Eine GET-Anfrage stellen

Eine GET-Anfrage wird gestellt, um vorhandene Daten abzurufen. Es gibt ein Objekt zurück, das weiter untersucht werden kann, um weitere Details über die gestellte Anfrage zu erhalten, indem das gewünschte Attribut darauf aufgerufen wird. Sehen Sie sich das folgende Anwendungsbeispiel an:

• Erstellen Sie eine Python-Datei, zum Beispiel get_request.py, schreiben Sie in die Datei den folgenden Code:

# Import the requests module
import requests

# Making a simple GET request
response_object = requests.get("https://jsonplaceholder.typicode.com/posts")

Aus dem Antwortobjekt können verschiedene Attribute aufgerufen werden:
status_code: HTTP-Statuscode der Antwort.

• .text: Der Antworttext als Zeichenfolge.
• .json(): Analysiert den Antworttext als JSON (falls zutreffend).
• .content: Der Antworttext als Rohbytes.
• .headers: Ein Wörterbuch der Antwortheader.
• .cookies: Vom Server gesetzte Cookies.
• .url: Die endgültige URL nach Weiterleitungen.
• .abgelaufen In diesem Artikel konzentrieren wir uns mehr auf das Attribut .json(). Rufen Sie in Ihrer request.py-Datei das Attribut .json() für das Antwortobjekt auf

json_data = response_object.json()
print(json_data)

Der zurückgegebene JSON wird in der Variablen json_data gespeichert und kann in Ihrem Programm verwendet werden.
Folgendes wird auf Ihrer Konsole ausgegeben.

Eine POST-Anfrage stellen

POST-Anfrage sendet Daten an einen angegebenen Endpunkt und erstellt einen neuen Datensatz. Im Gegensatz zur GET-Methode, die darauf abzielt, bereits vorhandene Daten abzurufen. Befolgen Sie die folgenden Schritte, um eine Post-Anfrage zu stellen:

• Erstellen Sie eine neue Datei mit dem Namen post_request.py oder einem anderen geeigneten Namen. Schreiben Sie den folgenden Code in die Datei:

python3 -m pip install requests

Dadurch werden Daten an den vorgeschriebenen Endpunkt gesendet und außerdem ein Antwortobjekt zurückgegeben; Dieses Objekt enthält mehrere nützliche Informationen über die gesendete POST-Anfrage. Der Zugriff erfolgt durch Aufrufen des entsprechenden Attributs am Objekt.
Rufen Sie das Attribut status_code für das Antwortobjekt auf, um sicherzustellen, dass der Vorgang erfolgreich war. Aktualisieren Sie Ihren Code.

python -m pip install requests

Es wird 201 zurückgegeben, was anzeigt, dass Ihre POST-Anfrage erfolgreich war und eine neue Ressource erstellt wurde. Wie im Bild unten gezeigt.

Eine PUT-Anfrage stellen

PUT-Anfrage beinhaltet das Ersetzen bestehender Datensätze durch neue; Es übernimmt neue Daten vom Absender oder Client und ersetzt die vorhandenen Daten damit.
So stellen Sie eine PUT-Anfrage:

• Erstellen Sie eine neue Python-Datei. Für diesen Artikel verwenden wir put_request.py. Schreiben Sie den folgenden Code hinein.

# Import the requests module
import requests

# Making a simple GET request
response_object = requests.get("https://jsonplaceholder.typicode.com/posts")

Eine DELETE-Anfrage stellen

Dadurch wird sichergestellt, dass ein bestimmter Datensatz oder bestimmte Daten entfernt werden. Der zu entfernende Datensatz wird immer durch seine eindeutige ID angegeben, die normalerweise angegeben wird.
So führen Sie einen DELETE-Vorgang durch:

• Erstellen Sie eine neue Python-Datei. Für diesen Artikel verwenden wir delete_request.py. Schreiben Sie den folgenden Code hinein:

json_data = response_object.json()
print(json_data)

Eine PATCH-Anfrage stellen

Verwenden Sie die PATCH-Methode immer dann, wenn Sie teilweise Änderungen an bereits vorhandenen Datensätzen oder Daten vornehmen möchten.

• Erstellen Sie eine neue Python-Datei. Für diesen Artikel verwenden wir patch_request.py. Schreiben Sie den folgenden Code hinein:

# Import the requests module
import requests


# Making a simple POST request


data = {'userId': 1, 'id': 1, 'title': 'This is for POST request', \
        'body': 'This body is modified for this technical writing article by Augustine Alul'}
response_object = requests.post("https://jsonplaceholder.typicode.com/posts/", data=data)


print(response_object.status_code)

Abschluss

Die requests-Bibliothek bietet eine vereinfachte Möglichkeit, HTTP-Anfragen in Ihrem Python-Code zu stellen; Es ermöglicht eine einfache Interaktion mit APIs und gibt ein Objekt zurück, das nützliche Informationen über die gestellte Anfrage bereitstellt, indem einfach das gewünschte Attribut aufgerufen wird (die Attribute finden Sie im Artikel).
Die Arbeit mit APIs in Python war nie einfacher – es gibt andere beliebte Bibliotheken für die Interaktion mit APIs in Python, aber die Requests-Bibliothek wurde aufgrund ihrer Einfachheit ausgewählt.
Vielen Dank, dass Sie bis zum Ende dieses Artikels geblieben sind. Dies vermittelt Ihnen einen guten Hintergrund, um mit der Arbeit mit APIs in Python zu beginnen.

Das obige ist der detaillierte Inhalt vonArbeiten mit APIs in Python: Ein praktischer Leitfaden. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!