Aktivieren Sie Try it für einen REST-Endpunkt eines API Gateway-Produkts in Ihrem Portal - Amazon API Gateway

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.

Aktivieren Sie Try it für einen REST-Endpunkt eines API Gateway-Produkts in Ihrem Portal

Verwenden Sie try it, damit ein API-Nutzer Ihren Produktendpunkt von Ihrem Portal aus aufrufen kann. Wenn ein API-Nutzer try it verwendet, gibt er Methodenanforderungsparameter ein und ruft Ihren Produktendpunkt auf. Dann ruft API Gateway Ihre API über das öffentliche Internet auf und gibt die Antwort im Testfenster zurück. Sie können eine benutzerdefinierte Produktseite verwenden, um zusätzliche Informationen zu den erforderlichen Parametern für den Zugriff auf Ihre API bereitzustellen.

API Gateway verwendet die folgenden Grenzwerte, um Ihre zu schützen APIs:

  • API Gateway erlaubt nur 3 Anfragen pro Sekunde an Ihre API.

  • API Gateway verwendet ein integriertes Timeout-Limit von 29000 ms. Ihre aktuelle API hat möglicherweise ein höheres Timeout-Limit, aber API Gateway wendet dieses Timeout nicht an, wenn ein Kunde es versucht.

  • API Gateway begrenzt die Antwortnutzlast auf 6 MB.

Überlegungen

Die folgenden Überlegungen können sich auf die Art und Weise auswirken, wie Sie es ausprobieren:

  • Try it wird in der Vorschau eines Portals nicht unterstützt.

  • Try it wird für den REST APIs mit den folgenden Funktionen nicht unterstützt:

    • Privat APIs

    • APIs die gegenseitiges TLS verwenden

    • APIs die private oder selbstsignierte SSL-Zertifikate verwenden

    Als Portalbesitzer sind Sie dafür verantwortlich, mit Ihren API-Nutzern zu kommunizieren. Die Begründung für die Schaltfläche „Warum versuchen“ gibt es nicht für REST APIs , die nicht unterstützt werden. API Gateway erklärt Ihnen das nicht.

Aktivieren Sie „Testen Sie es“ für einen REST-Endpunkt eines Produkts

Das folgende Verfahren zeigt, wie Sie Try It für einen Produktendpunkt aktivieren.

Informationen zur Verwendung von Try-it in einem Portal finden Sie unterVerwenden Sie ein API-Gateway-Portal.

Aktivieren Sie Try it für einen Produkt-REST-Endpunkt
  1. Wählen Sie im Hauptnavigationsbereich die Option Portal-Produkte aus.

  2. Wählen Sie ein Produkt aus.

  3. Wählen Sie auf der Registerkarte Dokumentation unter API-Referenzseiten den Namen eines Produkt-REST-Endpunkts aus, z. B. /dogs - GET.

  4. Wählen Sie Seite bearbeiten aus.

  5. Wählen Sie Funktionen testen aus, damit Kunden Ihre API in Ihrem Portal aufrufen können.

  6. Wählen Sie Änderungen speichern aus.

  7. Sie müssen alle Portale, die dieses Portalprodukt verwenden, erneut veröffentlichen, damit die Änderungen wirksam werden.