Daten an den und von dem Backend-Dienst übergeben
Wenn ein API-Client eine Anfrage an die in API Gateway bereitgestellte API sendet, Der Client kann einige oder alle der folgenden Informationen im Rahmen der Anfrage übergeben:
- Anfrageheader
- Abfrageparameter
- Formulardaten
- XML- oder JSON-Nutzlasten
- Anfragepfade
Beim Erstellen der Antwort auf die API-Anfrage kann der Back-End-Dienst Daten zurückgeben an den API-Client gesendet, einschließlich:
- Antwortheader
- XML- oder JSON-Nutzlasten
In diesem Dokument wird beschrieben, wie diese Daten an den und vom Back-End-Dienst übergeben werden.
Wie werden Anfragedaten an den Backend-Dienst übergeben?
Alle Daten in der Anfrage vom API-Client werden unverändert an den Back-End-Dienst übergeben. Es liegt dann an dem Back-End-Dienst, die Anfragedaten im Rahmen der Verarbeitung der Anfrage zu parsen.
Wie werden Antwortdaten an den API-Client zurückgegeben?
Alle in der Antwort vom Back-End-Dienst empfangenen Daten werden übergeben. unverändert zum API-Client. Der API-Client kann dann in der Antwort Daten zurückgegeben.
Wie wird die Anfrage-URL an den Back-End-Dienst übergeben?
Die URL, die für eine Anfrage an den Back-End-Dienst verwendet wird, wird vom
Erweiterung x-google-backend
.
In diesem Abschnitt werden die Optionen zum Konfigurieren der Back-End-Dienst-URL beschrieben.
Adresse und Pfad des Back-End-Dienstes in der OpenAPI-Spezifikation festlegen
In der OpenAPI-Spezifikation, mit der Sie eine API-Konfiguration erstellen, verwenden Sie die Methode
x-google-backend
, um die URL des Back-End-Dienstes anzugeben.
Beispielsweise geben Sie den Back-End-Dienst im folgenden Format an:
Backend | x-google-backend |
---|---|
Cloud Run-Funktionen | x-google-backend: address: https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello |
Cloud Run | x-google-backend: address: https://hello-HASH.a.run.app |
App Engine-Standardumgebung | x-google-backend: address: https://PROJECT_ID.appspot.com |
In diesen Beispielen gilt Folgendes:
- GCP_REGION gibt die GCP-Region für das bereitgestellte Back-End an.
- PROJECT_ID die Google Cloud-Projekt-ID angibt.
- HASH gibt den eindeutigen Hashcode an, der beim Erstellen des Cloud Run-Dienstes generiert wird.
Darüber hinaus gibt der Parameter path
in der OpenAPI-Spezifikation den Endpunkt oder die Ressource an.
die von Ihrer API unterstützt werden. Sie können einen absoluten Pfad oder einen Pfad angeben, der
Pfadparameter:
Pfad | Pfad mit Parametern |
---|---|
paths: /hello: |
paths: /hello/{name}: |
Back-End-Dienst-URL aus einer API-Anfrage generieren
Da API Gateway eine Anfrage vom API-Client verarbeitet, wird die Anfrage-URL vom API-Client gesendet und in die URL übersetzt, die für die Anfrage an den Back-End-Dienst verwendet wird. Die genaue Funktionsweise dieser Übersetzung hängt davon ab, welche Strategie für die Pfadübersetzung Sie verwenden.
Die Option path_translation
der Erweiterung x-google-backend
unterstützt zwei Strategien für die Pfadübersetzung:
APPEND_PATH_TO_ADDRESS
: Die Back-End-Dienst-URL wird durch Anhängen der Ressourcenpfad von der Clientanfrage zuraddress
-URL vonx-google-backend
.Die meisten Back-End-Dienste verwenden
APPEND_PATH_TO_ADDRESS
, da dies bedeutet, dass das Back-End Ressourcenpfad, der vom API-Client angegeben wurde.CONSTANT_ADDRESS
: Die Back-End-Dienst-URL ist konstant, wie durch dieaddress
URL der Erweiterungx-google-backend
. Wenn die Clientanfrage einen Ressourcenpfad enthält, wird der Ressourcenpfad mithilfe von Abfrageparametern zur Back-End-Dienst-URL hinzugefügt.Diese Methode wird normalerweise von Cloud Run-Funktionen verwendet.
Beispiel:
APPEND_PATH_TO_ADDRESS
address
:https://PROJECT_ID.appspot.com
- Ohne OpenAPI-Pfadparameter
- OpenAPI-Pfad:
/hello
- Ressourcenpfad der API-Clientanfrage:
/hello
- Anfrage-URL für Backend-Dienst:
https://PROJECT_ID.appspot.com/hello
- OpenAPI-Pfad:
- Mit OpenAPI-Pfadparameter
- OpenAPI-Pfad:
/hello/{name}
- Ressourcenpfad der API-Clientanfrage:
/hello/Dave
- Anfrage-URL für Backend-Dienst:
https://PROJECT_ID.appspot.com/hello/Dave
- OpenAPI-Pfad:
CONSTANT_ADDRESS
address
:https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello
- Ohne OpenAPI-Pfadparameter
- OpenAPI-Pfad:
/hello
- Ressourcenpfad der API-Clientanfrage:
/hello
- Anfrage-URL für Backend-Dienst:
https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello
- OpenAPI-Pfad:
- Mit OpenAPI-Pfadparametern
- OpenAPI-Pfad:
/hello/{name}
- Ressourcenpfad der API-Clientanfrage:
/hello/Dave
- Anfrage-URL für Backend-Dienst:
https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello?name=Dave
- OpenAPI-Pfad:
Einstellen von path_translation
Legen Sie path_translation
als Teil der Einstellung x-google-backend
fest:
x-google-backend: address: https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello path_translation: [ APPEND_PATH_TO_ADDRESS | CONSTANT_ADDRESS ]`
Der Standardwert von path_translation
hängt davon ab, wo Sie x-google-backend
festlegen
in Ihrer OpenAPI-Spezifikation:
Wenn
x-google-backend
auf der obersten Ebene der OpenAPI-Spezifikation verwendet wird, Die Standardeinstellung fürpath_translation
istAPPEND_PATH_TO_ADDRESS
.Wenn
x-google-backend
auf Vorgangsebene der OpenAPI-Spezifikation verwendet wird, Die Standardeinstellung fürpath_translation
istCONSTANT_ADDRESS
.