Externe API-Anforderung

Nicht zu viel Theorie?

Lassen Sie uns das in die Praxis umsetzen. Öffnen wir AppMaster, erstellen wir eine API-Anfrage und lernen wir die Funktionsweise dieser Anfrage besser kennen.

Erstellung einer externen API-Anfrage

API-Anforderungen werden im Abschnitt "Geschäftslogik" auf der Registerkarte "Externe API-Anforderungen" erstellt.

Klicken Sie nun auf "+ Neue API-Anfrage".

Der Name und die Beschreibung können frei gewählt werden, sie sind nur für unseren persönlichen Gebrauch bestimmt.

Kommen wir zu den Daten, die wirklich wichtig sind.

Das Minimum, das zum Erstellen einer Anfrage erforderlich ist, ist die Angabe der Methode und der Adresse (URL). Beginnen wir mit dem letzten Punkt.

URL

URL - Uniform Resource Locator. Eine Adresse, die einer bestimmten Ressource im Internet zugeordnet ist. Die bekannteste Version einer solchen Ressource ist eine HTML-Seite - wir geben ihre URL in die Adressleiste des Browsers ein und öffnen die gewünschte Seite. Dabei kann die Ressource selbst alles Mögliche sein, ein Bild, ein Video, ein Datensatz. Die Hauptsache ist, dass diese Ressource einen spezifischen Zeiger hat - eine URL, an die Sie eine Anfrage senden können, um diese Ressource zu erhalten.

Methoden

Indem wir uns auf die Daten an ihrer Adresse beziehen, geben wir auch die Methode (man kann auch sagen, den Typ) der Anfrage an, d. h. wir geben an, was mit diesen Daten tatsächlich getan werden muss.

Als wir Anfragen für die Aufgabe des ersten Moduls gesendet haben, haben wir Daten erhalten. Dies ist die GET-Methode. Diese Methode ist die naheliegendste und auch die einzige erforderliche Methode. Auch wenn wir sie nicht explizit angegeben haben, wurde daher standardmäßig angenommen, dass es sich um GET handelt.

Schauen wir uns an, welche anderen Methoden es gibt.

Der HTTP-Standard selbst schränkt die Anzahl der Methoden, die verwendet werden können, nicht ein. Gleichzeitig werden nur noch einige der gängigsten Methoden verwendet, um die Kompatibilität zu wahren. Es gibt 5 verschiedene Methoden, die in den AppMaster API-Anfragen verwendet werden können.

GET. Damit haben wir uns bereits beschäftigt. Die Methode fordert die Bereitstellung einer Ressource an und empfängt Daten.

POST. Um Daten von irgendwoher zu erhalten, müssen Sie diese Daten zunächst dort ablegen. Die POST-Methode macht genau das. Sie sendet Daten an den Server und erstellt eine Ressource.

PUT. Ähnlich wie die POST-Methode, aber ihre Aufgabe ist es, die Daten zu aktualisieren. Es werden keine neuen Daten erstellt, sondern bestehende Daten ersetzt und aktualisiert.

DELETE. Wie der Name schon sagt, löscht es Daten.

PATCH. Die Methode ist ähnlich wie PUT, wird aber verwendet, um die Daten teilweise zu aktualisieren, anstatt sie vollständig zu ersetzen. Mit der PATCH-Methode können Sie zum Beispiel den Titel eines Artikels oder den Wert eines Parameters ändern.

Dabei ist zu beachten, dass der Server nicht genau das tun muss, was in der Methode angegeben ist. Wir können die Adresse einer Seite mit der DELETE-Methode senden, aber das bedeutet nicht, dass der Server sie auch tatsächlich löscht. Rein theoretisch kann er dies aber auch mit dem GET-Befehl tun. Oder nichts ändern, aber gleichzeitig Daten als Antwort auf POST senden. Einfach weil der Entwickler es so konfiguriert hat.

Hier kommt REST ins Spiel, das besagt, dass es an der Zeit ist, sich auf die Einhaltung des Auftrags zu einigen, das Durcheinander zu beenden und genau das zu tun, was in der Methode angegeben ist. Zumindest sollte dies die Hauptaufgabe sein (wenn auch nicht unbedingt die einzige). Wenn Sie z. B. den Inhalt eines Artikels mit der GET-Methode übertragen, können Sie gleichzeitig den Zähler der Anzahl seiner Aufrufe um 1 erhöhen.

Wir haben also herausgefunden, wo sich die Daten befinden und was man mit ihnen machen kann. Schauen wir uns nun an, welche anderen Komponenten die Anfrage haben kann.

URL-Parameter

URL-Parameter. Es gibt Situationen, in denen wir nur einen Teil der URL kennen. Ein Beispiel sind die Artikel auf der Website Appmaster.io. Die Startadresse für alle Artikel ist die gleiche - https://appmaster.io/blog/. Aber dann hat jeder Artikel seinen eigenen Titel und dementsprechend seinen eigenen individuellen Teil für die genaue Angabe dieses speziellen Artikels.

In einer solchen Situation werden URL-Params verwendet. Wir geben den allgemeinen Teil sofort vor und überlassen den Rest dem Prozess. Im Ergebnis wird die URL in der Form https://appmaster.io/blog/:id/ geschrieben.

Der bekannte Teil wird so geschrieben, wie er ist, und der variable Teil wird hinter das ":"-Zeichen gesetzt. Der Name dieses variablen Teils (bereits ohne ":") wird in die Liste der Parameter aufgenommen. In diesem Fall kann es mehrere variable Teile geben, die an beliebiger Stelle in der URL stehen können.

Abfrage-Parameter

Abfrage-Parameter. Erinnern Sie sich daran, dass wir im ersten Modul eine Anfrage an boredapi.com geschickt haben? Dabei wurden neben der Adresse zusätzliche Daten vorgeschrieben. Das waren die Query Params.

Sie werden nach der URL geschrieben und sind durch ein "?"-Zeichen von ihr getrennt. Angegeben werden der Name des Parameters, das Zeichen "=" und der Wert des Parameters selbst. Wenn mehrere Parameter auf einmal verwendet werden, werden sie durch das Zeichen "&" getrennt.

Bei der Angabe von Parametern in AppMaster müssen Sie sich jedoch keine Gedanken über die Abfrageregeln machen. Alles wird automatisch richtig formatiert. Sie müssen nur den Namen des Parameters selbst angeben und ihn der Liste hinzufügen.

Query Params werden verwendet, wenn die Datenquelle dieselbe ist, aber die Daten selbst unterschiedlich sein können. Zum Beispiel enthielt Boredapi eine riesige Liste von Dingen, die zu tun waren. Wir waren aber nur an denjenigen interessiert, die für eine Person bestimmt sind, und das haben wir in den Abfrageparametern angegeben.

Ein weiterer Anwendungsfall ist die Begrenzung der Datenmenge. Wir könnten zum Beispiel auf eine Liste zugreifen, aber nur die ersten 5 Einträge abfragen. Diese Menge kann auch ein Abfrageparameter sein.

Eine weitere Möglichkeit ist ein Zugriffsschlüssel. Sie haben diese Option vielleicht schon in Modul 1 verwendet, als es um Alphavantage ging. Die Daten konnten nur nach Registrierung und Übermittlung eines persönlichen Schlüssels in den Abfrageparametern abgerufen werden.

Achten Sie auf die Seiten, die Sie im Internet besuchen, Sie werden wahrscheinlich auch dort verschiedene Parameter finden. Wenn Sie zum Beispiel die Wetterseite von Ventusky.com öffnen, werden in den Abfrageparametern geografische Werte für Breiten- und Längengrad gesendet.

Kopfzeilen

Kopfzeilen. Anfrage-Header. In der Regel enthalten Header Service-Informationen über die Anfrage (Meta-Informationen). Header ermöglichen es dem Server, weitere Informationen über den Client zu erhalten, der die Daten anfordert. Die Header können Informationen darüber enthalten, welcher Browser verwendet wird, in welcher Kodierung die Antwort erwartet wird, in welcher Sprache, den genauen Zeitpunkt der Anfrage und vieles mehr. Im Falle des Zugriffs auf geschützte Daten können die Header einen Autorisierungsschlüssel enthalten.

In den meisten Fällen sind die Header optional. Schon im ersten Modul haben wir eine Anfrage gestellt, bei der wir keine Kopfzeilen angegeben haben (was allerdings nicht bedeutet, dass die Anfrage tatsächlich ohne sie gesendet wurde).

Körper

Körper. Körper der Anfrage. GET-Anfragen kommen in der Regel ohne ihn aus, aber wenn wir einige Daten an den Server senden wollen, also eine POST- oder PUT-Anfrage stellen, dann werden diese Daten in den Body der Anfrage gestellt. Gleichzeitig können Sie Daten beliebiger Komplexität in den Request Body stellen, z. B. eine Videodatei senden, und sind nicht auf eine Zahl oder eine Textzeichenfolge beschränkt.