Integrations-Pass-Through-Verhalten - Amazon API Gateway

Integrations-Pass-Through-Verhalten

Wenn bei Nicht-Proxyintegrationen eine Methodenanforderung eine Nutzlast enthält und entweder der Content-Type-Header nicht der angegebenen Mapping-Vorlage entspricht oder keine Mapping-Vorlage definiert ist, können Sie die vom Client bereitgestellte Anforderungsnutzlast ohne Transformation über die Integrationsanforderung an das Backend weiterleiten. Dieser Prozess wird als "Integrations-Pass-Through" bezeichnet.

Bei Proxy-Integrationen leitet API Gateway die gesamte Anfrage an Ihr Backend weiter. Sie haben keine Möglichkeit, das Weiterleitungsverhalten zu ändern.

Das tatsächliche Pass-Through-Verhalten einer eingehenden Anforderung basiert auf der Option, die Sie beim Einrichten der Integrationsanforderung für eine bestimmte Mapping-Vorlage ausgewählt haben, und dem Content-Type-Header, den der Client in der eingehenden Anforderung festgelegt hat. Es gibt drei Optionen:

Wenn keine Vorlage mit dem angeforderten Inhaltstyp-Header übereinstimmt

Wählen Sie diese Option, falls der Methodenanforderungstext ohne Umwandlung durch die Integrationsanforderung an das Backend übergeben werden soll, sofern der Inhaltstyp der Methodenanforderung keinem mit den Zuweisungsvorlagen verknüpften Inhaltstyp entspricht.

Beim Aufruf der API-Gateway-API wählen Sie diese Option aus, indem Sie WHEN_NO_MATCH als passthroughBehavior-Eigenschaftswert für die Integration festlegen.

Wenn keine Vorlagen definiert sind (empfohlen)

Wählen Sie diese Option, falls der Methodenanforderungstext ohne Umwandlung durch die Integrationsanforderung an das Backend übergeben werden soll, sofern in der Integrationsanforderung keine Zuweisungsvorlage definiert ist. Wenn eine Vorlage definiert und diese Option ausgewählt ist, wird die Methodenanforderung eines nicht zugeordneten Inhaltstyps mit einer Antwort "HTTP 415 Unsupported Media Type" zurückgewiesen.

Beim Aufruf der API-Gateway-API wählen Sie diese Option aus, indem Sie WHEN_NO_TEMPLATES als passthroughBehavior-Eigenschaftswert für die Integration festlegen.

Niemals

Wählen Sie diese Option, falls der Methodenanforderungstext nicht ohne Umwandlung durch die Integrationsanforderung an das Backend übergeben werden soll, sofern in der Integrationsanforderung keine Zuweisungsvorlage definiert ist. Wenn eine Vorlage definiert und diese Option ausgewählt ist, wird die Methodenanforderung eines nicht zugeordneten Inhaltstyps mit einer Antwort "HTTP 415 Unsupported Media Type" zurückgewiesen.

Beim Aufruf der API-Gateway-API wählen Sie diese Option aus, indem Sie NEVER als passthroughBehavior-Eigenschaftswert für die Integration festlegen.

Die folgenden Beispiele veranschaulichen das mögliche Pass-Through-Verhalten.

Beispiel 1: Eine Mapping-Vorlage wird in der Integrationsanforderung für den Content-Type application/json definiert.

Content-Type-Header\ausgewählte Pass-Through-Option WHEN_NO_MATCH WHEN_NO_TEMPLATES NEVER
Keine (standardmäßig application/json) Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt. Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt. Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt.
application/json Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt. Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt. Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt.
application/xml Die Anforderungsnutzlast wird nicht umgewandelt, sondern unverändert an das Backend gesendet. Die Anforderung wird mit der HTTP-Antwort 415 Unsupported Media Type abgelehnt. Die Anforderung wird mit der HTTP-Antwort 415 Unsupported Media Type abgelehnt.

Beispiel 2: Eine Mapping-Vorlage wird in der Integrationsanforderung für den Content-Type application/xml definiert.

Content-Type-Header\ausgewählte Pass-Through-Option WHEN_NO_MATCH WHEN_NO_TEMPLATES NEVER
Keine (Standard application/json) Die Anforderungsnutzlast wird nicht umgewandelt, sondern unverändert an das Backend gesendet. Die Anforderung wird mit der HTTP-Antwort 415 Unsupported Media Type abgelehnt. Die Anforderung wird mit der HTTP-Antwort 415 Unsupported Media Type abgelehnt.
application/json Die Anforderungsnutzlast wird nicht umgewandelt, sondern unverändert an das Backend gesendet. Die Anforderung wird mit der HTTP-Antwort 415 Unsupported Media Type abgelehnt. Die Anforderung wird mit der HTTP-Antwort 415 Unsupported Media Type abgelehnt.
application/xml Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt. Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt. Die Anforderungsnutzlast wird anhand der Vorlage umgewandelt.