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 eine Produktseite in API Gateway
Eine Produktseite hilft Ihren Produktkonsumenten, Ihre Produkte zu verstehen und zu verwenden. Die Dokumentation bezieht sich auf Produktebene, sodass alle Portale, die Ihr Produkt anbieten, über diese Dokumentation verfügen. API Gateway unterstützt zwei Arten von Produktseiten, die in GitHub Flavored Markdown
- Seite „Übersicht“
-
Wenn Sie Ihr Produkt erstellen, generiert API Gateway automatisch eine Übersichtsseite für Ihr Produkt auf der Grundlage der Informationen, die Sie bei der Erstellung Ihres Produkts angeben. Diese Seite hat zusätzliche Formatierungen, die nicht geändert werden können. Sie können den Text ändern oder die Seite aus dem Portalprodukt entfernen.
- Benutzerdefinierte Seiten
-
Eine benutzerdefinierte Seite ist eine in Markdown geschriebene Seite. Sie können diesen Abschnitt für die Allgemeinen Geschäftsbedingungen oder ein Tutorial zur Verwendung Ihres Produkts verwenden. Sie können jede benutzerdefinierte Seite in eine Übersichtsseite umwandeln. Wenn Sie eine benutzerdefinierte Seite in eine Übersichtsseite ändern, wird der Seiteninhalt so formatiert, dass er der Übersichtsseite entspricht.
Überlegungen
Die folgenden Überlegungen könnten sich auf Ihre Verwendung von Produktseiten auswirken:
-
Diese Dokumentation bezieht sich nicht auf API-Ebene und enthält keine Methoden, Ressourcen oder Anforderungsparameter. Informationen zum Ändern der Dokumentation auf API-Ebene für ein Produkt finden Sie unter. Aktualisieren Sie einen Produkt-REST-Endpunkt in API Gateway
-
Sie können eine
.mdDatei nicht direkt in Ihr Produkt hochladen. -
Sie können die Reihenfolge der Produktseiten ändern, indem Sie die Seitenliste in der Anzeigereihenfolge Ihres Portalprodukts ändern. Weitere Informationen finden Sie unter Aktualisieren Sie ein Portalprodukt in API Gateway.
-
Sie müssen alle Portale, die Ihr Produkt enthalten, erneut veröffentlichen, damit die Änderungen an der Dokumentation wirksam werden.
-
Wenn Sie mehrere Portale haben, die dasselbe Portalprodukt verwenden, sind die Produktseiten auf allen Portalen identisch. Um dieselben Produkt-REST-Endpunkte, aber unterschiedliche Produktseiten zu haben, erstellen Sie mehrere Produkte.
Erstellen Sie eine Produktseite
Das folgende Verfahren zeigt, wie Sie eine Produktseite erstellen.
Um eine Produktseite zu erstellen
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 Produkt aus.
Wählen Sie unter Dokumentation die Option Benutzerdefinierte Seite erstellen aus.
Geben Sie unter Seitentitel den Seitentitel ein.
Geben Sie für Body Ihre ergänzende Dokumentation mit GitHub Flavored Markdown ein.
Im Bereich Vorschau wird gezeigt, wie Ihre Inhalte in einem Portal angezeigt werden. Der endgültige visuelle Stil kann sich je nach Ihren Portaleinstellungen ändern.
Wählen Sie Produktseite erstellen aus.
-
Ihre Produktseite ist jetzt ein Entwurf. Wählen Sie Dokumentationsseiten entwerfen und wählen Sie dann Ihre Produktseite aus, um den Inhalt der Seite fertigzustellen.
Wählen Sie „Seite bearbeiten“.
-
Geben Sie als Abschnittsname einen Namen ein oder wählen Sie einen vorhandenen Abschnitt aus. Wenn Sie Ihre Produktseite zu einem Bereich 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.
