Mit APIs ohne Code verbinden - Gunook

2024 Autor: John Day | [email protected]. Zuletzt bearbeitet: 2024-01-30 07:16

Dieser Leitfaden richtet sich an Personen, die etwas erreichen möchten, für das die Verwendung einer API erforderlich ist, aber nicht genau wissen, wie sie anfangen sollen. Sie wissen bereits, warum es nützlich ist, mit einer API zu arbeiten, und dieser Leitfaden zeigt Ihnen, wie das geht.

Wenn das nach Ihnen klingt, haben Sie Glück! Wir sind hier, um zu erklären, wie Sie mit APIs arbeiten, wie Sie API-Dokumente lesen und wie Sie die von einer API zurückkommenden Daten tatsächlich verwenden.

Wir haben einen Freund mitgebracht, um die Reise viel einfacher zu machen.

Treffen Sie Slash

Slash ist Michelles entzückender, liebenswerter Hund (Bild oben). Michelle ist Software-Ingenieurin, die APIs erstellt. Michelle genießt ihren Job wirklich und hat sich beim Training von Slash von ihrer Arbeit beim Erstellen von APIs inspirieren lassen.

Wie Sie vielleicht wissen, ist eine API eine Sammlung von Befehlen, die ein Benutzer zusammen mit einer Reihe von Antworten, die der Anfrage entsprechen, an einen Webdienst geben kann. Michelle hat Slash beigebracht, dasselbe zu tun. Slash ist ein guter Junge, kennt eine Vielzahl von Befehlen und antwortet immer richtig, solange Sie ihm eine Anfrage stellen, die er gelernt hat. Wenn er besonders aufgeregt ist, dreht sein Schwanz durch - das hat Michelle ihm nicht in Bezug auf APIs beigebracht, sondern nur, weil er ein liebenswerter Welpe ist und sein Training wirklich genießt!

Schritt 1: Entscheiden Sie, welche API Sie benötigen

Welche Informationen suchen Sie oder möchten Sie ändern?

Versuchen Sie, alle Instagram-Posts von @dougthepug zu erfassen? Vielleicht möchten Sie automatisch jedem twittern, der dem Twitter Ihres Hundes folgt (denn obwohl Hunde nicht sprechen können, haben sie viel zu sagen, wir wissen, dass Slash es tut).

Wenn Sie die Website oder API, zu der Sie eine Verbindung herstellen möchten, bereits kennen, fahren Sie direkt mit Schritt 2 fort. Wenn Sie versuchen, Daten zu finden, aber nicht sicher sind, wo Sie anfangen sollen, ist Google Ihr Freund. Suchen Sie nach "[stuff you are Interesting] API" und sehen Sie, was dabei herauskommt. Sie werden überrascht sein, wie viele Informationen es gibt.

Wenn Sie eine einfache Beispiel-API benötigen, können Sie die API verwenden, die Michelle beim Training von Slash erstellt hat. Es hat einige seiner Lieblingsbefehle wie das Zurückholen von Bällen und das Graben von Löchern. Wir werden es in den restlichen Beispielen verwenden.

Schritt 2: API-Dokumente suchen

APIs, die von namhaften Unternehmen bereitgestellt werden, sollten über eine gründliche Dokumentation ihrer Verwendung verfügen.

Diese finden Sie unter "[Firma einfügen] API-Dokumentation" oder "[Firma einfügen] Entwickler".

Die Ergebnisse sollten Sie zum Entwicklerportal führen. Suchen Sie nach einem Link mit der Aufschrift "Docs", "Documentation", "Reference" oder "Technical Reference".

In den Dokumenten müssen Sie möglicherweise nach der gewünschten API suchen, da es manchmal viele Optionen geben kann. Facebook beispielsweise verfügt über separate APIs für Marketing, Anzeigen, Seiten und mehr.

Wenn die API, zu der Sie eine Verbindung herstellen möchten, nicht bekannt ist (wie die von Slash), müssen Sie möglicherweise den Entwickler um Dokumentation bitten. Sie haben möglicherweise ein PDF mit den von Ihnen benötigten Informationen oder eine Online-Dokumentation, die nicht auf ihrer Website aufgeführt ist.

Wenn Sie den Link im vorherigen Schritt verpasst haben, finden Sie die API-Dokumentation von Slash hier.

Schritt 3: Finden Sie den Endpunkt

API-Dokumente mögen entmutigend aussehen, aber wenn Sie wissen, wonach Sie suchen müssen, sind sie normalerweise gut strukturiert und ziemlich standardisiert.

Das erste, wonach Sie suchen müssen, ist der/die geeignete(n) Endpunkt(e). Es sollte einen Endpunkt geben, der jedem gewünschten Datentyp entspricht. Ein Endpunkt könnte so aussehen:

slashtheapidog.com/api/bones/{id}

oder nur

/Knochen

Die Dokumentation sollte eine Liste der Endpunkte enthalten. Sie können sich auf der obersten Ebene in den Dokumenten oder unter einem Abschnitt namens "Referenz", "Endpunkte" oder "Methoden" befinden. Um den richtigen Endpunkt zu finden, suchen Sie nach dem Namen, der den gesuchten Daten entspricht. Wenn Sie beispielsweise eine Liste aller Löcher haben möchten, die Slash gegraben hat, ist /holes wahrscheinlich das richtige. Auf jeden Fall sollte jeder Endpunkt eine Beschreibung haben, um zu erklären, was er tut.

Aus seinen Dokumenten sind dies die Endpunkte in Slashs API, die sich auf Löcher beziehen:

Holen Sie sich

GET

POST

PUT

POST

Schritt 4: Bestimmen Sie Ihren Anfragetyp

Nachdem Sie nun den richtigen Endpunkt gefunden haben, müssen Sie den Typ der zu sendenden Anforderung bestimmen.

Es gibt 4 verschiedene Arten von Anfragen:

WERDEN

Mit einer GET-Anfrage bitten Sie die API, mit etwas zu antworten, das sie hat, meistens Daten. Sie können basierend auf dem Endpunkt und den Parametern spezifische Informationen zu einem Element oder einer Gruppe von Elementen anfordern. Dies ist das Äquivalent, Slash zu bitten, Ihnen einen seiner Knochen oder alle seine Knochen zu bringen.

POST

Mit einer POST-Anfrage weisen Sie die API an, etwas Neues zu erstellen. Dies ist vergleichbar damit, dass Sie Slash bitten, ein neues Loch für Sie zu graben (zu erstellen).

STELLEN

Mit einer PUT-Anfrage weisen Sie die API an, etwas zu aktualisieren, das zuvor erstellt wurde. Dies ähnelt der Aufforderung von Slash, tiefer in das von ihm gegrabene Loch zu graben (aktualisieren).

LÖSCHEN

Mit einer DELETE-Anfrage weisen Sie die API an, etwas zu löschen, das zuvor erstellt wurde. Dies ähnelt der Aufforderung von Slash, ein zuvor gegrabenes Loch zu vertuschen (zu löschen).

Denken Sie an diese vier Typen. Erhalten Sie Informationen, erstellen Sie einen neuen Eintrag, ändern Sie einen bestehenden Eintrag oder löschen Sie ihn? Diese Antwort sagt Ihnen genau, welchen Anforderungstyp Sie benötigen.

Schritt 5: Verstehen Sie die Parameter

Viele Anfragen erfordern zusätzliche Parameter. Parameter sind die Details Ihrer Anfrage. Wenn Sie beispielsweise möchten, dass Slash Ihnen alle roten Kugeln liefert, müssen Sie die Farbe angeben. Wenn Sie möchten, dass er ein neues Loch schafft, müssen Sie ihm sagen, wo er es platzieren und wie tief er graben soll.

Die API-Dokumentation, auf die Sie verweisen, sollte für jeden Endpunkt und jeden Anforderungstyp einen Abschnitt namens "Parameter" oder "Optionen" enthalten. Achten Sie darauf, welche Parameter erforderlich sind, da einige optional sind. Wenn ein Parameter als optional markiert ist, können die Dokumente ein Beispiel enthalten, das auch der Standard ist.

Die API-Parameter von Slash könnten zum Abrufen von Bällen etwa so aussehen:

Holen Sie sich

Schritt 6: Formatieren Sie Ihre Anfrage

Wir haben alle Informationen, die wir brauchen, jetzt müssen wir nur noch die Anfrage stellen!

Hier sind zwei verschiedene Möglichkeiten, eine Verbindung zu einer API herzustellen, für die kein Code erforderlich ist. Verbinden wir uns mit der API von Slash, um seine Liste der Bälle zu erhalten, indem wir eine GET-Anfrage an https://slashtheapidog.com/api/balls stellen

Parabel - wenn Sie sich ohne Code mit Daten verbinden und mit ihnen arbeiten möchten

Parabola ist eine Web-App, mit der Sie sich einfach mit APIs verbinden und dann über ein visuelles Drag-and-Drop-Tool mit den Daten arbeiten können.