Wichtige Hinweise zu Amazon API Gateway - APIAmazon-Gateway
Wichtige Hinweise für REST APIs HTTPAPIs, und WebSocket APIsWichtige Hinweise für REST APIs und WebSocket APIsWichtige Hinweise für WebSocket APIsWichtige Hinweise für REST APIs

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Wichtige Hinweise zu Amazon API Gateway

Im folgenden Abschnitt finden Sie Hinweise, die sich auf Ihre Nutzung von API Gateway auswirken könnten.

Wichtige Hinweise zu Amazon API Gateway für REST APIs HTTPAPIs, und WebSocket APIs

  • Signature Version 4A wird von Amazon API Gateway nicht offiziell unterstützt.

Amazon API Gateway: wichtige Hinweise für REST und WebSocket APIs

  • APIGateway unterstützt nicht die gemeinsame Nutzung eines benutzerdefinierten Domainnamens über REST und WebSocket APIs.

  • Phasennamen dürfen nur alphanumerische Zeichen sowie Binde- und Unterstriche enthalten. Die maximale Länge beträgt 128 Zeichen.

  • Die Pfade /ping und /sping sind für die Servicezustandsprüfung reserviert. Ihre Verwendung für Ressourcen API auf Stammebene mit benutzerdefinierten Domänen führt nicht zum erwarteten Ergebnis.

  • APIGateway begrenzt derzeit Protokollereignisse auf 1024 Byte. Protokollereignisse, die größer als 1024 Byte sind, wie z. B. Anforderungs- und Antworttexte, werden von API Gateway vor der Übermittlung an CloudWatch Logs gekürzt.

  • CloudWatch Metrics begrenzt derzeit Dimensionsnamen und -werte auf 255 gültige XML Zeichen. (Weitere Informationen finden Sie im CloudWatch Benutzerhandbuch.) Dimensionswerte hängen von benutzerdefinierten Namen ab, einschließlich API Name, Bezeichnung (Stufe) und Ressourcenname. Achten Sie bei der Auswahl dieser Namen darauf, die CloudWatch Metrikgrenzwerte nicht zu überschreiten.

  • Die maximale Größe einer Zuordnungsvorlage beträgt 300 KB.

Wichtige Hinweise zu Amazon API Gateway für WebSocket APIs

  • APIGateway unterstützt Nachrichtennutzlasten bis zu 128 KB mit einer maximalen Framegröße von 32 KB. Sie müssen Nachrichten, die 32 KB überschreiten, in mehrere Frames aufteilen, die jeweils 32 KB oder kleiner sind. Wenn eine größere Nachricht empfangen wird, wird die Verbindung mit Code 1009 geschlossen.

Wichtige Hinweise zu Amazon API Gateway für REST APIs

  • Das Klartext-Pipezeichen (|) wird für keine URL Anforderungsabfragezeichenfolge unterstützt und muss URL -kodiert sein.

  • Das Semikolon (;) wird für keine URL Anforderungsabfragezeichenfolge unterstützt und führt dazu, dass die Daten aufgeteilt werden.

  • RESTAPIsdekodieren Sie URL -kodierte Anforderungsparameter, bevor Sie sie an Backend-Integrationen übergeben. Bei UTF -8 Anforderungsparametern REST APIs dekodieren Sie die Parameter und übergeben sie dann als Unicode an Backend-Integrationen.

  • Wenn Sie die API Gateway-Konsole zum Testen eines verwendenAPI, erhalten Sie möglicherweise die Antwort „Unbekannte Endpunktfehler“, wenn dem Backend ein selbstsigniertes Zertifikat vorgelegt wird, das Zwischenzertifikat in der Zertifikatskette fehlt oder wenn andere nicht erkennbare zertifikatsbezogene Ausnahmen vom Backend ausgelöst werden.

  • Bei einer API ResourceMethodOder-Entität mit einer privaten Integration sollten Sie sie löschen, nachdem Sie alle hartcodierten Referenzen von a entfernt haben. VpcLink Andernfalls haben Sie eine fehlerhafte Integration und erhalten eine Fehlermeldung, die besagt, dass der VPC Link auch dann noch verwendet wird, wenn die Resource Method OR-Entität gelöscht wird. Dieses Verhalten liegt nicht vor, wenn die private Integration über eine Stufenvariable auf VpcLink verweist.

  • Die folgenden Backends unterstützen die SSL Client-Authentifizierung möglicherweise nicht auf eine Weise, die mit API Gateway kompatibel ist:

  • APIGateway unterstützt den Großteil der Open API 2.0-Spezifikation und der Open API 3.0-Spezifikation, mit den folgenden Ausnahmen:

    • Pfadsegmente dürfen nur alphanumerische Zeichen, Unterstriche, Bindestriche, Punkte, Kommas, Doppelpunkte und geschweifte Klammern enthalten. Pfadparameter müssen als separate Pfadsegmente vorliegen. Beispiel: "resource/{path_parameter_name}" ist gültig, "resource{path_parameter_name}" nicht.

    • Modellnamen dürfen nur alphanumerische Zeichen enthalten.

    • Als Eingabeparameter werden nur die folgenden Attribute unterstützt: name, in, required, type, description. Andere Attribute werden ignoriert.

    • Der securitySchemes-Typ muss bei Verwendung apiKey lauten. Die Authentifizierung OAuth 2 und HTTP Basic werden jedoch über Lambda-Autorisierer unterstützt; die API Open-Konfiguration wird über Herstellererweiterungen erreicht.

    • Das deprecated Feld wird nicht unterstützt und wird beim Export gelöscht. APIs

    • APIGateway-Modelle werden mithilfe von JSONSchemaentwurf 4 und nicht JSON anhand des von Open verwendeten Schemas definiertAPI.

    • Der Parameter discriminator wird in Schemaobjekten nicht unterstützt.

    • Das Tag example wird nicht unterstützt.

    • exclusiveMinimumwird von API Gateway nicht unterstützt.

    • Die Tags maxItems und minItems werden bei der einfachen Anforderungsvalidierung nicht berücksichtigt. Um dieses Problem zu umgehen, aktualisieren Sie das Modell nach dem Import, bevor Sie die Validierung vornehmen.

    • oneOfwird für Open API 2.0 oder SDK Generation nicht unterstützt.

    • Das Feld readOnly wird nicht unterstützt.

    • $ref kann nicht für den Verweis auf andere Dateien verwendet werden.

    • Antwortdefinitionen des "500": {"$ref": "#/responses/UnexpectedError"} Formulars werden im Open API Document Root nicht unterstützt. Ersetzen Sie die Referenz durch das Inline-Schema, um dieses Problem zu umgehen.

    • Zahlen vom Typ Int32 oder Int64 werden nicht unterstützt. Ein Beispiel sehen Sie unten:

      "elementId": {
    "description": "Working Element Id",
    "format": "int32",
    "type": "number"
}

    • Der Formattyp Dezimalzahl ("format": "decimal") wird in Schemadefinitionen nicht unterstützt.

    • In Methodenantworten muss die Schemadefinition ein Objekttyp sein und darf keine primitiven Datentypen umfassen. Beispielsweise wird "schema": { "type": "string"} nicht unterstützt. Sie können dies jedoch umgehen, indem Sie den folgenden Objekttyp verwenden:

      "schema": {
     "$ref": "#/definitions/StringResponse"
            }

 "definitions": {
    "StringResponse": {
      "type": "string"
    }
  }

    • APIGateway verwendet keine Sicherheit auf Stammebene, die in der API Open-Spezifikation definiert ist. Daher muss die Sicherheit auf Vorgangsebene definiert werdne, um korrekt angewendet werden zu können.

    • Das default-Schlüsselwort wird nicht unterstützt.

  • APIGateway erlässt die folgenden Einschränkungen und Beschränkungen beim Umgang mit Methoden mit Lambda-Integration oder HTTP Lambda-Integration.

    • Bei der Verarbeitung von Header-Namen und Abfrageparametern wird die Groß- und Kleinschreibung beachtet.

    • Die folgende Tabelle listet die Header auf, die gelöscht, erneut zugewiesen oder anderweitig modifiziert werden können, wenn sie an den Integrationsendpunkt oder von diesem zurückgesendet werden. In dieser Tabelle:

      • Remapped bedeutet, dass der Header-Name von <string> in X-Amzn-Remapped-<string> geändert wird.

        Remapped Overwritten bedeutet, dass der Header-Name von <string> in X-Amzn-Remapped-<string> geändert und der Wert überschrieben wird.

      Header-Name Anfrage (http/http_proxy/lambda) Antwort (http/http_proxy/lambda)
      Age Pass-Through Pass-Through
      Accept Pass-Through Gelöscht/Pass-Through/Pass-Through
      Accept-Charset Pass-Through Pass-Through
      Accept-Encoding Pass-Through Pass-Through
      Authorization Pass-Through* Remapped
      Connection Pass-Through/Pass-Through/Gelöscht Remapped
      Content-Encoding Pass-Through/Gelöscht/Pass-Through Pass-Through
      Content-Length Pass-Through (generiert auf der Grundlage des Inhalts) Pass-Through
      Content-MD5 Gelöscht Remapped
      Content-Type Pass-Through Pass-Through
      Date Pass-Through Neu zugeordnet überschrieben
      Expect Gelöscht Gelöscht
      Host Auf den Integrationsendpunkt überschrieben Gelöscht
      Max-Forwards Gelöscht Remapped
      Pragma Pass-Through Pass-Through
      Proxy-Authenticate Gelöscht Gelöscht
      Range Pass-Through Pass-Through
      Referer Pass-Through Pass-Through
      Server Gelöscht Neu zugeordnet überschrieben
      TE Gelöscht Gelöscht
      Transfer-Encoding Gelöscht/Gelöscht/Ausnahme Gelöscht
      Trailer Gelöscht Gelöscht
      Upgrade Gelöscht Gelöscht
      User-Agent Pass-Through Remapped
      Via Gelöscht/Gelöscht/Pass-Through Pass-Through/Gelöscht/Gelöscht
      Warn Pass-Through Pass-Through
      WWW-Authenticate Gelöscht Remapped

      * Der Authorization-Header wird gelöscht, wenn er eine Signaturversion 4-Signatur enthält oder AWS_IAM-Autorisierung verwendet wird.

  • Das Android einer SDK von API Gateway API generierten Datei verwendet die java.net.HttpURLConnection Klasse. Diese Klasse löst auf Geräten, auf denen Android 4.4 und früher ausgeführt wird, eine unbehandelte Ausnahme für eine 401-Antwort aus, die aus der Neuzuordnung des Headers WWW-Authenticate zu X-Amzn-Remapped-WWW-Authenticate resultiert.

  • Im Gegensatz zu den vom API Gateway generierten Java-, Android- und SDKs iOS-Versionen von an API unterstützt die JavaScript SDK von API Gateway API generierte Version keine Wiederholungsversuche bei Fehlern der Stufe 500.

  • Der Test-Aufruf einer Methode verwendet den Standard-Inhaltstyp application/json und ignoriert Spezifikationen anderer Inhaltstypen.

  • Beim Senden von Anfragen an eine, API indem der X-HTTP-Method-Override Header übergeben wird, API überschreibt Gateway die Methode. Um den Header an das Backend zu übergeben, muss der Header der Integrationsanforderung hinzugefügt werden.

  • Wenn eine Anfrage mehrere Medientypen in ihrem Accept Header enthält, API berücksichtigt Gateway nur den ersten Accept Medientyp. In Situationen, in denen Sie die Reihenfolge der Accept Medientypen nicht kontrollieren können und der Medientyp Ihres binären Inhalts nicht an erster Stelle in der Liste steht, können Sie den ersten Accept Medientyp in Ihre binaryMediaTypes Liste aufnehmen. API Gateway gibt Ihren API Inhalt als binär zurück. Um beispielsweise eine JPEG Datei mithilfe eines <img> Elements in einem Browser zu sendenAccept:image/webp,image/*,*/*;q=0.8, sendet der Browser möglicherweise eine Anfrage. Durch Hinzufügen image/webp zur binaryMediaTypes Liste erhält der Endpunkt die JPEG Datei als Binärdatei.

  • Das Anpassen der Standard-Gateway-Antwort für 413 REQUEST_TOO_LARGE wird derzeit nicht unterstützt.

  • APIGateway enthält einen Content-Type Header für alle Integrationsantworten. Der Inhaltstyp ist standardmäßig „application/json“.