Beispiel zum Erstellen Ihrer ersten API-Definition

APIs definieren

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

Erstellen Ihrer ersten API-Definition

In diesem Kurs verwenden wir eine Beispiel-OpenAPI-Spezifikation, die eine einfache Zeit-API definiert. Die Zeit-API hat eine einzige Operation,GET /api/time/v1/now, mit dem Benutzer das aktuelle Datum und die aktuelle Uhrzeit abfragen können. Diese API verwendet der Einfachheit halber keine Authentifizierung, sodass jeder, der die Adresse der API kennt, darauf zugreifen kann.

Wir werden an dieser Stelle nicht auf alle Details der OpenAPI-Spezifikation eingehen. Unsere Beispiel-API, die Time API, ist unkompliziert und im Kurs „Building Frends APIs“ erfahren Sie mehr über die OpenAPI-Spezifikation.

OpenAPI-Spezifikation der Zeit-API

openapi: 3.0.1 Info: Titel: Zeit-API Beschreibung: API stellt aktuelle Zeit bereit Version: 1.0.0 Server: - URL: /api/time/v1 Pfade: /now: get: Parameter: - Name: Format in: Abfragebeschreibung: Format, in dem das aktuelle Datum/die aktuelle Uhrzeit zurückgegeben werden soll Erforderlich: false Schema: Typ: Zeichenfolge Antworten: „200“: Beschreibung: ok Inhalt: Anwendung/Text: Schema: Typ: Zeichenfolge

Um die OpenAPI-Spezifikation der Time API in Ihre Frends-Umgebung zu kopieren, folgen Sie diesen Schritten:

  1. Kopieren Sie die ursprüngliche OpenAPI-Spezifikation der Time API in Ihre Zwischenablage.

  2. Offendie Webseitemit der ursprünglichen OpenAPI-Spezifikation in einem neuen Browser-Tab oder -Fenster.

  3. Wählen Sie in der API-Listenansicht die Entwicklungsagentengruppe und klicken Sie auf die Schaltfläche „+ Neu erstellen“, um eine neue API zu erstellen.

  4. Entfernen Sie die standardmäßige OpenAPI-Spezifikation für die Beispiel-API und fügen Sie die OpenAPI-Spezifikation der Zeit-API aus Ihrer Zwischenablage ein.

  5. Klicken Sie auf „Änderungen speichern“, um die Zeit-API zu speichern.

Beachten Sie, dass die OpenAPI-Spezifikation allein nichts bewirkt; wir müssen noch die API-Implementierung erstellen. Im nächsten Schritt verwenden wir einen Frends-Prozess, um die API-Implementierung zu erstellen, die ausgeführt wird, wenn die GET-Anweisung der Time API/JetztDer Vorgang wird von API-Clients aufgerufen.

Der nächste Artikel istEinführung in die Erstellung verknüpfter Prozesse


Verwandte ArtikelBest Practices zur Versionierung von APIsEinführung in das Erstellen Ihrer ersten API und API-DefinitionEinführung in den Header-Abschnitt der API-DefinitionEinführung in die API-TriggereinstellungenEinführung in die Definition der Verwendung von API-Schlüsseln in der OpenAPI-Spezifikation