Aktualisieren Sie einen Produkt-REST-Endpunkt in API Gateway - 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.

Aktualisieren Sie einen Produkt-REST-Endpunkt in API Gateway

Wenn Sie einen Produkt-REST-Endpunkt aktualisieren, können Sie alle Einstellungen des Produktendpunkts ändern, mit Ausnahme des Pfads und der Methode einer REST-API sowie der Phase, in der sie bereitgestellt wird. Alle Änderungen an Ihren Produktendpunkten werden automatisch aktualisiert. Sie müssen jedoch alle Portale, die Ihre Produkte verwenden, erneut veröffentlichen, damit sich die Änderungen in einem Portal widerspiegeln.

Aktualisieren Sie einen Produkt-REST-Endpunkt

Das folgende Verfahren zeigt, wie Sie einen Produkt-REST-Endpunkt aktualisieren, um die aktuelle API-Dokumentation mit der benutzerdefinierten API-Referenzdokumentation zu überschreiben.

Um einen Produkt-REST-Endpunkt zu aktualisieren
  1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

  2. Wählen Sie im Hauptnavigationsbereich Portal-Produkte aus.

  3. Wählen Sie ein Produkt aus.

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

  5. Wählen Sie für Vorschau die Option Seite bearbeiten aus.

  6. Aktivieren Sie unter Dokumentationsquelle die Option Dokumentation überschreiben.

  7. Wählen Sie für Inhalt anzeigen die Option Vorhandenen Inhalt überschreiben aus.

    Wenn Sie „Gesamten Inhalt entfernen“ wählen, wird der Inhalt von der Seite entfernt. Sie können jedoch „Vorhandenen Inhalt überschreiben“ wählen, um erneut auf die Dokumentation zuzugreifen.

  8. Geben Sie im Hauptteil der Seite die benutzerdefinierte API-Referenzdokumentation mit GitHub Flavored Markdown ein.

    Diese Dokumentation wird nicht zurück an API Gateway weitergegeben.

  9. Wählen Sie Änderungen speichern aus.

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