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.
API-Gateway-Portale
Sie können ein API-Gateway-Portal verwenden, um Ihre APIs und Ihre API-Dokumentation auf einer Webseite mit API-Verbrauchern zu teilen. Ein Portal enthält eine Reihe von Portalprodukten. Jedes Portalprodukt ist eine logische Gruppierung von REST APIs und enthält die Dokumentation, die Sie für Ihre API-Nutzer erstellen und veröffentlichen. Produktseiten innerhalb eines Portals enthalten die benutzerdefinierte Dokumentation auf Portalproduktebene. Die REST-Endpunktseiten der Produkte enthalten die Dokumentation für jeden REST APIs sowie den Pfad, die Methode und die Phase einer REST-API. Die Kombination aus Produktseiten und REST-Endpunktseiten der Produkte bietet die vollständige Dokumentation, damit API-Nutzer lernen können, wie sie mit der Nutzung Ihres REST beginnen können APIs.
Verwenden Sie ein Portal, um Folgendes zu tun:
-
Verwenden Sie API Gateway für Ihren gesamten API-Lebenszyklus, von der Erstellung Ihrer API über deren Dokumentation APIs bis hin zur Verteilung.
Teilen Sie Portalprodukte für mehrere AWS Konten.
-
Passen Sie einen zentralen Ort für Ihre Portalprodukte an, teilen Sie ihn und stellen Sie Produktseiten bereit.
Überlegungen
Die folgenden Überlegungen könnten sich auf Ihre Nutzung von API Gateway Gateway-Portalen auswirken:
Sie können nur Portale erstellen, um REST gemeinsam zu nutzen APIs.
-
Portale werden auf AWS Regionsebene erstellt. Ihr Portal kann nur REST enthalten APIs , die sich in derselben Region befinden, in der Sie das Portal erstellt haben.
-
Sie können das AWS-Managementkonsole, oder nur verwenden AWS CLI, um Ihre Portale AWS SDKs zu erstellen und gemeinsam zu nutzen.
-
Sie können den Zugriff auf Ihr Portal nur mithilfe von Amazon Cognito Cognito-Benutzerpools steuern. Ihre Portalnutzer können sich entweder direkt über einen Benutzerpool anmelden oder sich über einen externen Identitätsanbieter (IdP) zusammenschließen. Wenn Sie einen Amazon Cognito Cognito-Benutzerpool verwenden, können Sie kein geheimes Client-Geheimnis für Ihren Benutzerpool festlegen. Weitere Informationen finden Sie unter Amazon Cognito Cognito-Benutzerpools.
