API-Passthroughs

Frends Frends Developer Documentation
1

Neue Funktion in Frends 5.7, API Passthroughs ermöglichen die Weiterleitung von HTTP(s)-Anfragen ohne die Notwendigkeit von Prozessen

Ossi Galkin avatarGeschrieben vonOssi Galkin Vor über einer Woche aktualisiert

Was sind API-Passthroughs?

API-Passthroughs dienen als Proxys für APIs innerhalb von Frends und ermöglichen Benutzern das Definieren einer Ziel-URL. Wenn die API aufgerufen wird, wird die Anforderung an die angegebene Ziel-URL weitergeleitet.
​Notiz:Passthroughs sind ausschließlich auf plattformübergreifenden Agenten verfügbar.

Zielkonfiguration

Benutzer können eine Ziel-URL konfigurieren, um Umgebungsvariablen zu verwenden. Darüber hinaus kann sie so eingestellt werden, dass die in der Anfrage angegebenen BasePath-, OperationPath- und QueryParameters weitergeleitet werden.

Beispiele:

  1. API-Bedienung: /api/Zeit/v1/Zeit
    ​Anfrage: /api/Zeit/v1/Zeit?locale=fi
    ​Ziel: {{#env.Target.Server}}/{{#api.BasePath}}/datetime/{{#api.QueryParameters.locale}}
    ​Gelöstes Ziel: https://example.com/api/time/v1/datetime/fi

  2. API-Bedienung: /api/Zeit/v1/Zeit/{Gebietsschema}/{Format}
    ​Anfrage: /api/zeit/v1/zeit/fi/5
    ​Ziel: https://domain.com/timeapi/{{#api.OperationPath.locale}}?format={{#api.OperationPath.format}}
    ​Gelöstes Ziel: https://domain.com/timeapi/fi?format=5

Ressourcenfreigabe zwischen verschiedenen Ursprüngen (CORS)

CORS kann für einen Passthrough aktiviert werden, indem im Feld „Zulässige Ursprünge“ eine durch Kommas getrennte Liste angegeben wird.
​

Header-Konfiguration

Vor der Weiterleitung an das Ziel können Header für die Passthrough-Anforderung konfiguriert werden.

Zu den Header-Optionen gehören:

  • Hinzufügen:Fügt den Header-Wert an einen vorhandenen Header-Namen an. Wenn der Header nicht vorhanden ist, wird er hinzugefügt.

  • Überschreiben:Überschreibt den Header-Namen mit dem bereitgestellten Header-Wert.

  • Entfernen:Entfernt den Header-Namen, falls vorhanden.

Erstellen/Ändern von API-Passthroughs

API-Passthroughs können erstellt werden, indem Sie auf die API-Verwaltungsseite zugreifen und auf die Schaltfläche „Passthrough-API erstellen“ klicken. Vorhandene Passthroughs können geändert werden, indem Sie an derselben Stelle „Passthrough-API ändern“ auswählen.

Löschen von API-Passthroughs

API-Passthroughs können gelöscht werden, indem Sie für einen bestimmten Vorgang auf das Aktionsmenü (...) zugreifen.

API-Prozess- und API-Passthrough-Konflikte

Es ist nicht möglich, gleichzeitig einen verknüpften API-Prozess und einen Passthrough für denselben Vorgang zu haben.

Wenn Konflikte auftreten:

  • Beispiel 1:Wenn sowohl ein API-Prozess als auch ein Passthrough für denselben Vorgang konfiguriert sind und das Passthrough standardmäßig generiert wird, hat der API-Prozess Vorrang.

  • Beispiel 2:Wenn sowohl ein API-Prozess als auch ein Passthrough für denselben Vorgang konfiguriert sind und das Passthrough nicht standardmäßig generiert wird, hat das API-Passthrough Vorrang.

Verwandte ArtikelAPI-TriggerEinführung in API TriggerBeispiel für eine binäre HTTP-AntwortEinführung in die Definition der Verwendung von API-Schlüsseln in der OpenAPI-Spezifikation5.7 Versionshinweise