Aktivieren der Binärunterstützung über die Gateway-Konsole API

In diesem Abschnitt wird erklärt, wie die Binärunterstützung mithilfe der API Gateway-Konsole aktiviert wird. Als Beispiel verwenden wir eine, API die in Amazon S3 integriert ist. Wir konzentrieren uns darauf, die unterstützten Medientypen festzulegen und anzugeben, wie die Nutzlast verarbeitet werden soll. Ausführliche Informationen zum Erstellen eines in Amazon S3 API integrierten Systems finden Sie unterTutorial: Einen REST API als Amazon S3 S3-Proxy erstellen.

So aktivieren Sie die Binärunterstützung mithilfe der API Gateway-Konsole

1. Legen Sie binäre Medientypen fest fürAPI:

   1. Erstellen Sie ein neues API oder wählen Sie ein vorhandenes ausAPI. In diesem Beispiel nennen wir den APIFileMan.

   2. Wählen Sie unter dem API im primären Navigationsbereich ausgewählten Bereich die Option APIEinstellungen aus.

   3. Wählen Sie im APIEinstellungsbereich im Abschnitt Binäre Medientypen die Option Medientypen verwalten aus.

   4. Klicken Sie auf Binären Medientyp hinzufügen.

   5. Geben Sie einen erforderlichen Medientyp (z. B. image/png) im Eingabetextfeld ein. Wiederholen Sie diesen Schritt bei Bedarf, um weitere Medientypen hinzuzufügen. Um alle binären Medientypen zu unterstützen, legen Sie fes */*.

   6. Wählen Sie Änderungen speichern aus.

2. Legen Sie fest, wie Nachrichten-Payloads für die API Methode behandelt werden:

   1. Erstellen Sie eine neue oder wählen Sie eine vorhandene Ressource in derAPI. In diesem Beispiel wird die Ressource /{folder}/{item} verwendet.

   2. Erstellen Sie eine neue Methode oder wählen Sie eine vorhandene Methode für die Ressource aus. Als Beispiel verwenden wir die GET /{folder}/{item}-Methode, die mit der Object GET-Aktion in Amazon S3 integriert ist.

   3. Wählen Sie unter Inhaltsbehandlung eine Option aus.

      

      Wählen Sie Pass-Through, wenn der Textkörper nicht konvertiert werden soll, wenn Client und Backend das gleiche Binärformat akzeptieren. Wählen Sie In Text umwandeln, um den Binärtext in eine Base64-kodierte Zeichenfolge zu konvertieren, wenn das Backend beispielsweise verlangt, dass eine Nutzlast einer binären Anfrage als Eigenschaft übergeben wird. JSON KLicken Sie auf In Binärdaten umwandeln, wenn der Client eine base64-kodierte Zeichenfolge übermittelt, aber für das Backend das ursprüngliche Binärformat erforderlich ist, oder wenn der Endpunkt eine base64-kodierte Zeichenfolge zurückgibt und der Client nur eine binäre Ausgabe akzeptiert.

   4. Wählen Sie für Anforderungstext-Pass-Through die Option Wenn keine Vorlagen definiert sind (empfohlen) aus.

      Alternativ können Sie auch Nie auswählen. Das bedeutet, dass Daten mit Inhaltstypen, für API die es keine Zuordnungsvorlage gibt, zurückgewiesen werden.

   5. Behalten Sie den Accept-Header der eingehenden Anforderung in der Integrationsanforderung bei. Sie sollten dies auch tun, wenn Sie contentHandling auf passthrough festgelegt haben und diese Einstellung zur Laufzeit überschrieben werden soll.

      

   6. Für eine Umwandlung in Text definieren Sie eine Mapping-Vorlage, um die base64-kodierten binären Daten in das erforderliche Format zu bringen.

      Im Folgenden sehen Sie ein Beispiel für eine Zuordnungsvorlage, die in Text konvertiert werden kann:

      {
        "operation": "thumbnail",
        "base64Image": "$input.body"
      }

      Das Format dieser Mapping-Vorlage hängt von den Anforderungen des Endpunkts an die Eingabe ab.

   7. Wählen Sie Speichern.