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.
Erstellen Sie einen Produkt-REST-Endpunkt in API Gateway
Ein Produkt-REST-Endpunkt ist ein Zugriffspunkt zu Ihrem Portalprodukt. Jeder Endpunkt besteht aus dem Pfad und der Methode einer REST-API sowie der Phase, in der sie bereitgestellt wird. Der Endpunkt enthält jegliche Dokumentation, die Sie für Ihre REST-API definiert haben, oder kann mit benutzerdefinierter Dokumentation aktualisiert werden. Wenn Sie Ihren Produkt-REST-Endpunkt erstellen, konfigurieren Sie die folgenden Einstellungen:
-
Der Betriebsname des REST-Endpunkts des Produkts. Wenn Ihre REST-API den Pfad und die Methode hat
GET /pets, lautet der Name in einem Portal/pets. Mithilfe des Vorgangsnamens können Sie den Namen des REST-Endpunkts des Produkts in ändernPet summaries. Dies hat keine Auswirkungen auf Ihre bestehende API. -
Die Try It-Funktionalität für Ihren Produktendpunkt. Auf diese Weise können API-Nutzer Ihre App APIs in Ihrem Portal testen. Wenn Sie einen Produktendpunkt für eine private API erstellen, ist die Testfunktion auf eingestellt
UNAVAILABLE. Weitere Informationen finden Sie unter Aktivieren Sie Try it für einen REST-Endpunkt eines API Gateway-Produkts in Ihrem Portal. -
Wenn Sie derzeit Dokumentationsteile für Ihre REST-API definiert haben, können Sie entweder die Dokumentation importieren oder Ihre bestehende Dokumentation überschreiben und mit GitHub Flavored
Markdown eine neue Dokumentation auf Produktebene erstellen. Alle Dokumentationsüberschreibungen werden nicht auf die Teile Ihrer API Gateway Gateway-API-Dokumentation zurückübertragen. Wenn Sie Ihre aktuellen Dokumentationsteile importieren, synchronisiert API Gateway Änderungen in Ihrer API mit Ihrem Produkt-REST-Endpunkt.
Erstellen Sie einen Produkt-REST-Endpunkt
Das folgende Verfahren zeigt, wie Sie einem vorhandenen Portalprodukt einen Produkt-REST-Endpunkt hinzufügen. Informationen zum gemeinsamen Erstellen eines Portalprodukts und eines Produkt-REST-Endpunkts finden Sie unterErstellen Sie ein Portalprodukt in API Gateway.
So erstellen Sie einen Produkt-REST-Endpunkt für ein Produktportal
Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan
. Wählen Sie im Hauptnavigationsbereich Portal-Produkte aus.
Wählen Sie ein Portalprodukt aus.
Wählen Sie die Registerkarte Zugeordnete Endpunkte und anschließend Endpunkte hinzufügen aus.
-
Um Ihre Produkt-REST-Endpunkte auszuwählen, wählen Sie unter API-Endpunkte eine API und dann eine Phase aus.
Um Ihren Produkt-REST-Endpunkten einen Endpunkt hinzuzufügen, wählen Sie den API-Endpunkt aus und wählen Sie dann Zum Produkt hinzufügen aus.
Der API-Endpunkt wird in der Liste Ausgewählte API-Endpunkte angezeigt.
Wählen Sie Absenden aus.
-
Ihre REST-Endpunktseite für Ihr Produkt ist jetzt ein Entwurf. Wählen Sie „API-Referenzseiten entwerfen“ und anschließend Ihre REST-Endpunktseite für Ihr Produkt aus, um den Inhalt der Seite fertigzustellen.
Wählen Sie „Seite bearbeiten“.
-
Um die bestehende API Gateway Gateway-Dokumentation zu überschreiben, aktivieren Sie für Dokumentationsquelle die Option Dokumentation überschreiben und gehen Sie wie folgt vor:
Wählen Sie für Inhalt anzeigen die Option Überschreiben erstellen aus.
Geben Sie unter Operationsname einen neuen Operationsnamen ein.
Geben Sie für Seitentext Ihre benutzerdefinierte Dokumentation ein.
-
(Optional) Geben Sie für Endpoint einen benutzerdefinierten Endpunkt ein, der in Ihrem Portal angezeigt wird.
-
Wählen Sie Funktionalität testen aus, damit Kunden Ihre API in Ihrem Portal aufrufen können. Weitere Informationen finden Sie unter Aktivieren Sie Try it für einen REST-Endpunkt eines API Gateway-Produkts in Ihrem Portal.
-
Geben Sie als Abschnittsname einen Namen ein oder wählen Sie einen vorhandenen Abschnitt aus. Wenn Sie Ihren Produkt-REST-Endpunkt zu einem Abschnitt hinzufügen, können Verbraucher Ihre Inhalte auf einem veröffentlichten Portal einsehen.
Wählen Sie Änderungen speichern aus.
Damit die neue Seite für Verbraucher sichtbar ist, müssen Sie Ihr Portal dennoch erneut veröffentlichen. Weitere Informationen finden Sie unter Veröffentlichen Sie ein Portal in API Gateway.
