Verwenden des Serverless-Entwicklerportals, um Ihre API Gateway-APIs zu katalogisieren - Amazon API Gateway

Verwenden des Serverless-Entwicklerportals, um Ihre API Gateway-APIs zu katalogisieren

Ein Entwicklerportal ist eine Anwendung, mit der Sie Ihren Kunden APIs zur Verfügung stellen. Sie können das Serverless-Entwicklerportal verwenden, um API Gateway-verwaltete APIs direkt über API Gateway zu veröffentlichen. Sie können damit auch nicht von API Gateway verwaltete APIs veröffentlichen, indem Sie OpenAPI-Definitionen für sie hochladen. Wenn Sie APIs in einem Entwicklerportal veröffentlichen, können Ihre Kunden ganz einfach:

  • Herausfinden, welche APIs verfügbar sind

  • Ihre API-Dokumentation durchsuchen

  • Sich für einen eigenen API-Schlüssel registrieren – und diesen sofort abrufen –, um damit Anwendungen zu erstellen.

  • Ihre APIs in der Benutzeroberfläche des Entwicklerportals ausprobieren

  • Die Nutzung ihrer eigenen API überwachen

Amazon API Gateway veröffentlicht eine regelmäßig aktualisierte Serverless-Entwicklerportal-Anwendung im AWS Serverless Application Repository und auf GitHub. Dies wird im Rahmen der Apache 2.0-Lizenz veröffentlicht und kann individuell angepasst und in Ihre Build- und Entwicklungstools integriert werden. Das Frontend ist in React geschrieben und kann vollständig angepasst werden. Weitere Informationen finden Sie unter https://github.com/awslabs/aws-api-gateway-developer-portal/wiki/Customization.

Weitere Informationen zum AWS Serverless Application Repository finden Sie im AWS Serverless Application RepositoryEntwicklerhandbuch für.

Tipp

Ein Beispiel eines Entwicklerportals, das ausprobiert werden kann, finden Sie unter https://developer.exampleapigateway.com/.

Erstellen eines Entwicklerportals

Sie können das Serverless-API-Gateway-Entwicklerportal unverändert bereitstellen oder entsprechend Ihrem Branding anpassen. Es gibt zwei Möglichkeiten, um Ihr Entwicklerportal bereitzustellen:

  • Mithilfe von AWS Serverless Application Repository. Wählen Sie die Schaltfläche Bereitstellen aus, um den AWS CloudFormation-Stack des Serverless-API-Gateway-Entwicklerportals zu starten, und geben Sie ein einige Stack-Parameter in der Lambda-Konsole ein.

  • Durch Herunterladen des Serverless-API-Gateway-Entwicklerportals aus dem AWS-GitHub-Repository und Launchen des AWS CloudFormation-Stacks des Serverless-API-Gateway-Entwicklerportals über die AWS SAM CLI.

So stellen Sie das Serverless-Entwicklerportal mit AWS Serverless Application Repository bereit

  1. Rufen Sie die Seite Serverless-API-Gateway-Entwicklerportal im AWS Serverless Application Repository auf.

  2. Wählen Sie Deploy (Bereitstellen) aus.

    Anmerkung

    Sie werden möglicherweise aufgefordert, sich bei der AWS Lambda-Konsole anzumelden.

  3. In der Lambda-Konsole geben Sie unter Application settings (Anwendungseinstellungen) die erforderlichen Stack-Parameter für das Entwicklerportal ein.

    Anmerkung

    Die Namen des S3-Buckets und das Amazon Cognito-Domänenpräfix sind erforderlich. Die anderen Einstellungen sind optional.

  4. Wenn Sie die Kunden-Feedback-Schaltfläche Ihre Meinung aktivieren möchten, müssen Sie Folgendes tun:

    • Geben Sie im Feld DevPortalAdminEmail eine E-Mail-Adresse ein. Wenn ein Kunde Feedback übermittelt, wird eine E-Mail an diese Adresse gesendet.

      Anmerkung

      Wenn Sie keine E-Mail-Adresse angeben, wird die Schaltfläche Ihre Meinung im Entwicklerportal nicht angezeigt.

    • Sie können optional einen Tabellennamen in das Feld DevPortalFeedbackTableName eingeben. Der Standardname lautet DevPortalFeedback. Wenn ein Kunde Feedback sendet, wird es in einer DynamoDB-Tabelle mit diesem Namen gespeichert.

  5. Aktivieren Sie das Kontrollkästchen neben Ich bestätige, dass diese App benutzerdefinierte IAM-Rollen und Ressourcenrichtlinien erstellt.

  6. Wählen Sie Deploy (Bereitstellen) aus.

  7. Wenn Sie eine E-Mail-Adresse im AdminEmail-Stack-Parameter eingegeben haben, wird eine Amazon SNS-Abonnement-E-Mail an diese Adresse gesendet. Diese E-Mail bestätigt, dass Sie das Amazon SNS-Thema abonnieren möchten, das Sie mit der Einstellung MarketplaceSubscriptionTopicProductCode angegeben haben.

So laden Sie das Serverless-Entwicklerportal mit herunter und stellen es berei AWS SAM

  1. Stellen Sie sicher, dass Sie die neueste AWS CLI und AWS SAM-CLI installiert und konfiguriert haben.

  2. Laden oder klonen Sie das Serverless-API Gateway-Entwicklerportal-Repository.

  3. Stellen Sie sicher, dass Sie einen privaten Amazon S3-Bucket haben, in dem Sie die gezippten Lambda-Funktionen hochladen können. Wenn dies nicht der Fall ist, können Sie mit der Amazon S3-Konsole oder CLI einen Bucket erstellen.

    Führen Sie in der AWS SAM CLI im Projektstammverzeichnis den folgenden Befehl aus, und ersetzen Sie dabei {your-lambda-artifacts-bucket-name} durch den Namen Ihres Amazon-S3-Buckets:

    sam package --template-file ./cloudformation/template.yaml \ --output-template-file ./cloudformation/packaged.yaml \ --s3-bucket {your-lambda-artifacts-bucket-name}
  4. Für diesen Schritt finden Sie unter Einstellungen des Entwicklerportals weitere Informationen zu Parametern (z. B. CognitoDomainNameOrPrefix) --parameter-overrides.

    Anmerkung

    Stellen Sie sicher, dass Sie einen privaten Amazon-S3-Bucket haben, in dem Sie die AWS SAM-Vorlage hochladen können. (AWS CloudFormation liest die Vorlage aus dem Bucket für die Bereitstellung des Entwicklerportals.) Dabei kann es sich um denselben Bucket handeln, den Sie im vorherigen Schritt für den Upload der gezippten Lambda-Funktionen angegeben haben.

    Führen Sie den folgenden Befehl im Projektstammverzeichnis aus und ersetzen Sie Folgendes:

    • {your-template-bucket-name} durch den Namen Ihres Amazon S3-Buckets.

    • {custom-prefix} durch ein Präfix, das global eindeutig ist.

    • {cognito-domain-or-prefix} durch eine eindeutige Zeichenfolge.

    sam deploy --template-file ./cloudformation/packaged.yaml \ --s3-bucket {your-template-bucket-name} \ --stack-name "{custom-prefix}-dev-portal" \ --capabilities CAPABILITY_NAMED_IAM \ --parameter-overrides CognitoDomainNameOrPrefix= "{cognito-domain-or-prefix}" DevPortalSiteS3BucketName="{custom-prefix}-dev-portal-static-assets" ArtifactsS3BucketName="{custom-prefix}-dev-portal-artifacts"

Nachdem Ihr Entwicklerportal vollständig bereitgestellt wurde, können Sie folgendermaßen seine URL anfordern.

So rufen Sie die URL für Ihr neu erstelltes Entwicklerportal ab:

  1. Öffnen Sie die AWS CloudFormation-Konsole.

  2. Wählen Sie den Namen des Stacks aus (aws-serverless-repository-api-gateway-dev-portal ist die Standard-Stack-Namen).

  3. Öffnen Sie den Abschnitt Outputs. Die URL für das Entwicklerportal ist in der Eigenschaft WebsiteURL angegeben.

Einstellungen des Entwicklerportals

Die folgenden Einstellungen müssen Sie während und nach der Bereitstellung Ihres Entwicklerportals festlegen:

Anmerkung

Viele der folgenden Einstellungen können Sie nach der Bereitstellung Ihres Entwicklerportals ändern, indem Sie den AWS CloudFormation-Stack aktualisieren. Weitere Informationen finden Sie unter Updates an AWS CloudFormation-Stacks.

ArtifactsS3BucketName (erforderlich)

Im Bereitstellungsprozess wird ein privat zugänglicher Amazon S3-Bucket erstellt, in dem die Katalog-Metadaten gespeichert werden. Geben Sie einen Namen für den Bucket an. Dieser Name muss global eindeutig sein.

CognitoDomainNameOrPrefix (erforderlich)

Diese Zeichenfolge wird mit der von Amazon Cognito gehosteten Benutzeroberfläche zur Benutzerregistrierung und -anmeldung verwendet. Geben Sie einen eindeutigen Domänennamen oder eine eindeutige Präfix-Zeichenfolge an.

CognitoIdentityPoolName

Der Bereitstellungsprozess erstellt einen Amazon Cognito-Identitätspool. Der Standardname für den Identitätspool lautet DevPortalIdentityPool.

CustomDomainNameAcmCertArn

Wenn Sie einen mit einem ACM-Zertifikat verknüpften Domänennamen angegeben haben, müssen Sie auch hier den ARN des ACM-Zertifikats angeben. Lassen Sie dieses Feld leer, um ein Entwicklerportal ohne einen benutzerdefinierten Domänennamen zu erstellen.

DevPortalAdminEmail

Geben Sie eine E-Mail-Adresse an, um die Kunden-Feedback-Schaltfläche Got an opinion? (Ihre Meinung) zu aktivieren. Wenn ein Kunde Feedback übermittelt, wird eine E-Mail an diese Adresse gesendet.

Anmerkung

Wenn Sie keine E-Mail-Adresse angeben, wird die Schaltfläche Ihre Meinung im Entwicklerportal nicht angezeigt.

DevPortalFeedbackTableName

Wenn Sie eine E-Mail-Adresse für DevPortalAdminEmail angeben, wird während des Bereitstellungsprozesses eine DynamoDB-Tabelle erstellt, in der das Feedback der Kunden gespeichert wird. Der Standardname lautet DevPortalFeedback. Sie können optional einen eigenen Tabellennamen angeben.

DevPortalCustomersTableName

Der Bereitstellungsprozess erstellt eine DynamoDB-Tabelle, in der Kundenkonten gespeichert werden. Optional können Sie einen Namen für diese Tabelle angeben. Er muss innerhalb Ihrer Kontenregion eindeutig sein. Standardmäßig lautet der Name der Tabelle DevPortalCustomers.

DevPortalSiteS3BucketName (erforderlich)

Während des Bereitstellungsprozesses wird ein privat zugänglicher Amazon S3-Bucket erstellt, in dem der Webanwendungscode gespeichert wird. Geben Sie einen Namen für diesen Bucket an. Dieser Name muss global eindeutig sein.

MarketplaceSubscriptionTopicProductCode

Dies ist das Amazon SNS-Themensuffix für das Abonnieren bzw. Beenden des Abonnements. Geben Sie den gewünschten Wert ein. Der Standardwert ist DevPortalMarketplaceSubscriptionTopic. Diese Einstellung ist nur relevant, wenn Sie AWS Marketplace -Integration verwenden. Weitere Informationen finden Sie unter Onboarding für SaaS-Kunden.

StaticAssetRebuildMode

Standardmäßig werden bei der Neuerstellung statischer Komponenten keine benutzerdefinierten Inhalte überschrieben. Geben Sie overwrite-content an, um benutzerdefinierte Inhalte durch Ihre lokale Version zu ersetzen.

Wichtig

Wenn Sie overwrite-content angeben, gehen alle benutzerdefinierten Änderungen in Ihrem Amazon S3-Bucket verloren. Machen Sie das nur, wenn Sie sich ganz sicher sind.

StaticAssetRebuildToken

Geben Sie ein anderes Token als das der letzten Bereitstellung an, um die statischen Komponenten der Entwicklerportal-Website erneut hochzuladen. Sie können einen Zeitstempel oder eine GUID für jede Bereitstellung angeben, um die Komponenten immer neu hochzuladen.

UseRoute53Nameservers

Gilt nur, wenn Sie einen benutzerdefinierten Domänennamen für Ihr Entwicklerportal erstellen. Wenn auf true eingestellt, werden eine Route 53 HostedZone und ein RecordSet für Sie erstellt. Andernfalls belassen Sie diese Einstellung auf false und stellen Sie Ihr eigenes Nameserver-Hosting bereit.

Erstellen eines Admin-Benutzers für Ihr Entwicklerportal

Nach der Bereitstellung Ihres Entwicklerportals erstellen Sie mindestens einen Admin-Benutzer. Erstellen Sie dazu einen neuen Benutzer und fügen Sie ihn der Administratorgruppe für den Amazon-Cognito-Benutzerpool hinzu, der von AWS CloudFormation beim Bereitstellen des Entwicklerportals erstellt wurde.

Erstellen eines Admin-Benutzers

  1. Wählen Sie in Ihrem Entwicklerportal Register (Registrieren) aus.

  2. Geben Sie eine E-Mail-Adresse und ein Passwort ein, und wählen Sie Registrieren.

  3. Melden Sie sich in einer separaten Registerkarte Ihres Webbrowsers bei der Amazon Cognito-Konsole an.

  4. Wählen Sie Manage User Pools (Benutzerpools verwalten).

  5. Wählen Sie den Benutzerpool für Ihr Entwicklerportal aus, den Sie beim Bereitstellen des Entwicklerportals festgelegt haben.

  6. Wählen Sie den Benutzer aus, den Sie zum Administrator hochstufen möchten.

  7. Wählen Sie Add to group (Zur Gruppe hinzufügen) aus.

  8. Wählen Sie im Dropdown-Menü {stackname}-dev-portalAdminsGroup aus, wobei {stackname} der Stack-Name aus der Bereitstellung des Entwicklerportals ist.

  9. Wählen Sie Add to group (Zur Gruppe hinzufügen) aus.

  10. Melden Sie sich in Ihrem Entwicklerportal ab und mit denselben Anmeldeinformationen wieder an. Sie sollten nun den Link Admin Panel (Adminbereich) in der oberen rechten Ecke neben My Dashboard (Mein Dashboard) sehen.

Verwalten von Benutzern in Ihrem Entwicklerportal

Nachdem Sie sich als Admin-Benutzer angemeldet haben, können Sie den Abschnitt Accounts (Konten) des Admin Panel (Admin-Bereich) verwenden, um Benutzer zu verwalten. Ein Admin-Benutzer kann neue Benutzer einladen, Benutzer löschen und vorhandenen Benutzern über das Entwicklerportal Admin-Status verleihen.

Veröffentlichen einer von API Gateway verwalteten API in Ihrem Entwicklerportal

In den folgenden Schritten wird beschrieben, wie Sie als API-Besitzer eine API in Ihrem Entwicklerportal veröffentlichen, damit Ihre Kunden sie abonnieren können.

Schritt 1: Bereitstellen einer von API Gateway verwalteten API für die Veröffentlichung

  1. Sofern noch nicht geschehen, stellen Sie die API für eine Stufe bereit.

  2. Sofern noch nicht geschehen, erstellen Sie einen Nutzungsplan und verknüpfen Sie ihn mit der API-Stufe für die bereitgestellte API.

    Anmerkung

    Sie müssen keine API-Schlüssel dem Nutzungsplan zuordnen. Das erledigt das Entwicklerportal für Sie.

  3. Melden Sie sich beim Entwicklerportal an und wechseln Sie zum Adminbereich.

  4. Die API sollte in der API-Liste Admin Panel (Adminbereich) aufgeführt sein. In der API-Liste sind APIs nach Nutzungsplan gruppiert. Die nicht abonnierbare No Usage Plan (Kein Nutzungsplan)-Gruppe enthält die APIs, die nicht mit einem Nutzungsplan verknüpft sind.

Schritt 2: Anzeigen der von API Gateway verwalteten API im Entwicklerportal

  1. Aktivieren Sie in der API-Liste Admin Panel (Adminbereich) den Wert Displayed (Angezeigt) für Ihre API. Beim ersten Upload wird dieser Wert auf Falsch festgelegt.

  2. Wählen Sie die Schaltfläche False (Falsch) aus, um die API im Entwicklerportal sichtbar zu machen. Der Wert ändert sich in Wahr, was darauf hinweist, dass die API jetzt sichtbar ist.

    Tipp

    Wählen Sie die Schaltfläche False (Falsch) oder Partial (Teilweise) in der Kopfzeile des Nutzungsplans aus, um alle APIs in einem Nutzungsplan sichtbar zu machen.

  3. Navigieren Sie zum APIs-Bereich, um das Entwicklerportal so angezeigt zu bekommen wie Ihre Kunden. In der linken Navigationsleiste sollte Ihre API aufgelistet werden.

    Wenn die API für eine Stufe bereitgestellt wird, die mit einem Nutzungsplan verknüpft ist, sollte die Schaltfläche Abonnieren für die API angezeigt werden. Diese Schaltfläche bewirkt, dass der API-Schlüssel des Kunden mit dem Nutzungsplan verknüpft wird, dem die API zugeordnet ist.

Da die von API Gateway verwaltete API nun angezeigt wird, können Sie die SDK-Generierung aktivieren, damit Ihre Kunden ein entsprechendes SDK herunterladen können.

Schritt 3: Aktivieren der SDK-Generierung

  1. Wählen Sie in der API-Liste Admin Panel (Adminbereich) die Schaltfläche Disabled (Deaktiviert) aus. Der Wert ändert sich in Aktiviert, was anzeigt, dass die SDK-Generierung nun erlaubt ist.

  2. Navigieren Sie zum APIs-Bereich und wählen Sie Ihre API in der linken Navigationsleiste aus. Ihnen sollten nun die Schaltflächen Download SDK (SDK herunterladen) und Export API (API exportieren) angezeigt werden.

Aktualisieren oder Löschen einer von API Gateway verwalteten API

Wenn Sie Ihre API in API Gateway nach dem Veröffentlichen ändern, müssen Sie sie erneut bereitstellen.

So aktualisieren Sie eine von API Gateway verwaltete API

  1. Ändern Sie die API wie gewünscht in der API-Gateway-Konsole, der AWS CLI oder einem SDK.

  2. Stellen Sie die API derselben Stufe bereit wie zuvor.

  3. Wählen Sie im Entwicklerportal in der API-Liste Admin Panel (Adminbereich) den Eintrag Update (Aktualisieren) aus. Dadurch wird die in der Entwicklerportal-Benutzeroberfläche angezeigte API aktualisiert.

    Anmerkung

    Die Schaltfläche Download SDK (SDK herunterladen) ruft immer die letzte bereitgestellte Version Ihrer API ab, auch wenn sie im Entwicklerportal nicht aktualisiert wird.

  4. Navigieren Sie zum APIs-Bereich und wählen Sie Ihre API in der linken Navigationsleiste aus. Sie sollten Ihre Änderungen sehen.

So blenden Sie eine API in der API-Liste des Entwicklerportals aus (ohne den Zugriff der Kunden darauf zu widerrufen)

  1. Aktivieren Sie in der API-Liste Admin Panel (Adminbereich) den Wert Displayed (Angezeigt) für Ihre API. Wenn die API sichtbar ist, wird dieser Wert auf Wahr gesetzt.

  2. Wählen Sie die Schaltfläche True (Wahr) aus, um die API auszublenden. Der Wert ändert sich in Falsch, was darauf hinweist, dass die API jetzt unsichtbar ist.

  3. Navigieren Sie zum APIs-Bereich. Die API sollte in der linken Navigationsleiste nicht mehr angezeigt werden.

Wenn Sie den Zugriff der Kunden auf eine API zurücknehmen möchten, ohne sie vollständig zu löschen, müssen Sie in der API Gateway-Konsole oder der API Gateway-CLI oder REST-API folgendermaßen vorgehen:

  • Entfernen Sie die API-Schlüssel aus dem Nutzungsplan.

  • Entfernen Sie die API-Stufe aus dem Nutzungsplan.

Entfernen einer nicht von API Gateway verwalteten API

Damit eine API, die nicht von API Gateway verwaltet wird, nicht mehr angezeigt und der Kundenzugriff darauf entfernt wird, wählen Sie Delete (Löschen) aus. Dadurch wird nicht die API, sondern deren OpenAPI-Spezifikationsdatei aus dem Entwicklerportal gelöscht.

Veröffentlichen einer nicht von API Gateway verwalteten API in Ihrem Entwicklerportal

In den folgenden Schritten wird beschrieben, wie Sie APIs an Ihre Kunden veröffentlichen, die nicht von API Gateway verwaltet werden („generische“ APIs). Sie können OpenAPI 2.0 (Swagger)- oder 3.x-Definitionen für die APIs in JSON-, YAML- oder YML-Dateien hochladen.

So veröffentlichen Sie eine nicht von API Gateway verwaltete API in Ihrem Entwicklerportal

  1. Melden Sie sich beim Entwicklerportal an und wechseln Sie zum Adminbereich.

  2. Wählen Sie unter Generic APIs (Generische APIs) die Option Add API (API hinzufügen) aus.

  3. Navigieren Sie zu dem Verzeichnis, in dem die OpenAPI-Dateien für Ihre APIs gespeichert sind, und wählen Sie die Dateien aus, die Sie hochladen möchten.

  4. Klicken Sie auf Upload.

    Anmerkung

    Wenn eine der Dateien nicht analysiert werden kann oder keinen API-Titel enthält, erhalten Sie eine Warnung. Diese Dateien werden dann nicht hochgeladen. Alle anderen Dateien werden hochgeladen. Sie müssen das x-Symbol auswählen, um das Dialogfeld zu schließen.

  5. Ihre API sollte jetzt unter Generic APIs (Generische APIs) aufgelistet werden. Wenn Sie sie nicht sehen, verlassen Sie den Admin Panel (Adminbereich) und kehren Sie wieder dorthin zurück, um die Liste zu aktualisieren.

Wie Ihre Kunden Ihr Entwicklerportal verwenden

Um Anwendungen zu erstellen und Ihre APIs zu testen, müssen Ihre Kunden Entwicklerkonten erstellen und sich dazu bei Ihrem Entwicklerportal registrieren.

So erstellen Sie ein Entwicklerkonto und erhalten einen API-Schlüssel:

  1. Wählen Sie im Entwicklerportal Registrieren.

  2. Geben Sie eine E-Mail-Adresse und ein Passwort ein, und wählen Sie Registrieren.

  3. Wählen Sie zum Suchen nach dem API-Schlüssel My Dashboard (Mein Dashboard).

Ein Entwicklerkonto stellt Ihrem Kunden einen API-Schlüssel zur Verfügung, der normalerweise benötigt wird, um Ihre APIs zu verwenden und zu testen. Es ermöglicht die Verfolgung der Nutzung sowohl für Sie als auch für Ihre Kunden.

Wenn sich ein Kunde zum ersten Mal registriert ist sein neuer API-Schlüssel nicht mit einer Ihrer APIs verbunden.

So aktivieren Sie den API-Schlüssel für eine API:

  1. Wählen Sie APIs.

  2. Wählen Sie die API aus der API-Liste aus und dann Abonnieren.

    Dies bewirkt, dass der API-Schlüssel mit dem Nutzungsplan verknüpft wird, dem die API zugeordnet ist.

Der Kunde hat jetzt die API abonniert und kann Methoden auf der API aufrufen. Tägliche Nutzungsstatistiken für die API werden in MyDashboard angezeigt.

Kunden können API-Methoden in der Entwicklerportal-Benutzeroberfläche ohne Abonnement ausprobieren.

Anmerkung

Wenn eine der API-Methoden einen API-Schlüssel erfordert, wird die Schaltfläche Authorize (Genehmigen) oberhalb der Methodenliste angezeigt. Methoden, die einen API-Schlüssel erfordern, werden mit einem schwarzen Schlosssymbol markiert. Um Methoden auszuprobieren, für die ein API-Schlüssel erforderlich ist, wählen Sie die Schaltfläche Authorize (Genehmigen) aus und geben Sie einen gültigen API-Schlüssel ein, der mit dem Nutzungsplan für die API-Stufe verknüpft ist.

Sie können die Schaltfläche Authorize (Genehmigen) für APIs ignorieren, die Sie bereits abonniert haben.

Ihre Kunden können Kundenfeedback über das Entwicklerportal einreichen.

Das Feedback des Kunden wird in der DynamoDB-Tabelle für das Entwicklerportal gespeichert. Der Standardname dieser Tabelle lautet DevPortalFeedback. Außerdem wird eine E-Mail an die E-Mail-Adresse gesendet, die im Feld DevPortalAdminEmail angegeben wurde. Wenn bei der Bereitstellung des Entwicklerportals keine E-Mail-Adresse angegeben wurde, ist die Schaltfläche Got an opinion? (Ihre Meinung) nicht sichtbar.

Anmerkung

Wenn Sie den Namen dieser Tabelle ändern, müssen Sie einen Namen verwenden, der innerhalb Ihrer Kontoregion eindeutig ist.

Wenn Sie die SDK-Generierung für die API im Admin Panel (Admin-Bereich) aktiviert haben, kann der Kunde ein entsprechendes SDK herunterladen und die API-Definition herunterladen. Weitere Informationen hierzu finden Sie unter Generieren eines SDK für eine REST-API in API Gateway und REST-API von API Gateway importieren.

Bewährte Methoden für Entwicklerportale

Die folgenden bewährten Methoden werden für die Bereitstellung eines Entwicklerportals empfohlen.

  • In den meisten Fällen werden Sie nur ein Entwicklerportal für alle Ihre APIs bereitstellen wollen. In einigen Fällen denken Sie vielleicht über separate Entwicklerportale für Entwicklungs- und Produktionsversionen Ihrer APIs nach. Es wird nicht empfohlen, mehr als ein Entwicklerportal für Produktions-APIs zu verwenden.

  • Wenn Sie einen Nutzungsplan erstellen und ihn einer Stufe zuordnen, müssen Sie keine API-Schlüssel mit dem Nutzungsplan verknüpfen. Das erledigt das Entwicklerportal für Sie.

  • Hinweis: Wenn beliebige APIs in einem bestimmten Nutzungsplan sichtbar sind, können alle APIs in diesem Nutzungsplan abonniert werden. Dies gilt auch dann, wenn Sie sie für Ihre Kunden noch nicht sichtbar gemacht haben.