Einführung in das Erstellen Ihrer ersten API und API-Definition

Grundlegende Konzepte der API-Entwicklung

Aleksi Hytönen avatarGeschrieben vonAleksi Hytönen Vor über einer Woche aktualisiertTable of contents

Einführung in den Aufbau Ihrer ersten API – Was bauen wir?

In diesem Kurs lernen Sie anhand eines Beispiels, wie Sie mit Frends eine einfache REST-API erstellen. Sie erfahren auch, wo Sie Ressourcen finden, um Ihr Wissen zu erweitern und komplexere APIs zu erstellen.

Eine REST- oder RESTful-API ist ein Architekturstil für eine Anwendungsprogrammierschnittstelle (API), dienutzt HTTP-Anfragen für den Zugriff auf und die Nutzung von Daten. Die Daten können verwendet werden, um GET-, PUT-, POST- und DELETE-Operationen an Ressourcen durchzuführen, die das Lesen, Aktualisieren, Erstellen und Löschen von Datentypen beinhalten.

Um die Entwicklung zu erleichtern und ein einfaches Beispiel zu präsentieren, das Sie ändern und erweitern können, bietet der Kurs eine Beispielvorlage für die erste API.

Einführung in die API-Definition

Eine der wichtigsten Aufgaben beim Erstellen einer API ist das Entwerfen der API-Definition. Die API-Definition ist eine Blaupause, die die Schnittstelle der API umreißt.

Die API-Definition gibt an:

  • Die Art der von der API bereitgestellten Daten und Funktionen

  • Die verfügbaren Operationen, die vom API-Client aufgerufen werden können

  • Die von jedem API-Vorgang verwendeten Parameter

  • Die von den API-Operationen zurückgegebenen Daten und das Format, in dem sie zurückgegeben werden

In Frends wird die API-Definition mithilfe desOpenAPI-Spezifikation, ein standardmäßiges API-Beschreibungsformat. Diese Spezifikation war früher als Swagger-Spezifikation bekannt und wird manchmal als OAS bezeichnet.

Der nächste Artikel istBeispiel zum Erstellen Ihrer ersten API-Definition


Verwandte ArtikelEinführung in das Testen einer API und API – SchlüsselkonzepteBeispiel zum Erstellen Ihrer ersten API-DefinitionEinführung in die Bereitstellung Ihrer APIEinführung in die OpenAPI-SpezifikationEinführung in den Header-Abschnitt der API-Definition