Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsEinführung
In diesem Kurs werden wir uns ansehen, wie man API-Spezifikationen in Frends schreibt. Sie erfahren etwas über Pfadversionsnummern, welche Formate unterstützt werden und wie man den Swagger-Editor in Frends verwendet.
APIs sind eine großartige Möglichkeit, Ihre Freunde zu nutzen und eine API-basierte Integration zwischen verschiedenen Systemen zu erstellen.
HTTP-Methoden
Frends API wurde im Restful-Verfahren entwickelt. Dies gibt Ihnen einige Richtlinien zum Erstellen Ihrer APIs und welche Prinzipien Sie bei der Entwicklung Ihrer APIs berücksichtigen können. REST-APIs verfügen über diese HTTP-Methoden, die die Funktionen der Ressource beschreiben.
ERHALTEN
Get-Anfragen werden verwendet, um Daten und Ressourcen vom Server abzurufen und sollten niemals einen Anfragetext enthalten. Anfragetexte sind zulässig, sollten jedoch keinen semantischen Wert haben.
POST
Post-Anfragen dienen zum Erstellen neuer Ressourcen. Sie können Post verwenden, um vorhandene Daten zu aktualisieren. Damit dies jedoch funktioniert, müssen Sie die gesamte Struktur der aktualisierten Ressource bereitstellen. Dies bedeutet normalerweise, dass Sie die Ressource zuerst mit einer Get-Anfrage abrufen müssen, bevor Sie die erforderlichen Änderungen vornehmen und die Ressource mit der Post-Anfrage veröffentlichen.
SETZEN
Put-Anfragen dienen zum Ersetzen einer Ressource und werden deshalb normalerweise mit den Patch-Verben verwechselt. Put-Anfragen führen einen exakten Ersatz der Ressource durch die angegebenen Daten durch.
PATCH
Patch-Anfragen dienen der tatsächlichen Aktualisierung und Änderung von Ressourcen und können beispielsweise teilweise Änderungen an der Ressource verarbeiten.
LÖSCHEN
Löschanforderungen dienen zum Entfernen vorhandener Ressourcen.
Idempotenz
POST ist die einzige HTTP-Methode, die nicht idempotent ist. Das bedeutet, dass Post-Anfragen eine bestimmte Anzahl von Malen ausgeführt werden können und der Server mit jeder Anfrage über die gleiche Menge an neuen Ressourcen verfügt. Alle anderen Methoden sollten immer so implementiert werden, dass sie idempotent bleiben und sich der Ressourcenstatus nach der ersten Anfrage nicht ändert. Insbesondere die Delete-Methode kann gefährlich sein, wenn die Idempotenz nicht berücksichtigt wird. Stellen Sie sich eine Situation vor, in der Sie einen Endpunkt /items/last mit einer angehängten Delete-Methode haben. Dies könnte zu einer Situation führen, in der ein Schleifenmechanismus dieser Anfragen alle Elemente aus dem Elementkatalog des Servers entfernen könnte.
Der nächste Artikel istEinführung in die Benennung und Versionierung von API-Spezifikationen.
Verwandte ArtikelSchreiben einer API-Spezifikation in Frends: Teil 1Verwaltungs-APIEinführung in Integrationen mit HTTPEinführung in die Nutzung von REST-APIsEinführung in die API-Triggereinstellungen