API testen

Entwickler können nicht nur die Referenzdokumentation der SmartDocs API aufrufen, sondern auch im Bereich API testen mit Ihrer API interagieren, ohne die API-Dokumentation zu verlassen. Auf Ihrem Portal haben Entwickler die Möglichkeit, Anfragen an Ihre API zu senden und die Antworten anzusehen. Dadurch, dass Nutzer die API in Ihrem Portal testen können, wird ihnen schneller klar, wie sie ihren Code für die Verwendung der API anpassen müssen.

Wenn für Ihre API ein API-Schlüssel oder eine Authentifizierung erforderlich ist, konfigurieren Sie Ihr Portal so, dass die Nutzer mit Ihrer API interagieren können. Auf dieser Seite wird beschrieben, welche Voraussetzungen Sie schaffen und welche Konfigurationen Sie vornehmen müssen, damit Entwickler den Bereich API testen verwenden können. Zu jeder Aufgabe werden die Rollen für Identity and Access Management (IAM) angegeben, die mindestens für die Durchführung der Aufgabe erforderlich sind. Weitere Informationen zu IAM-Berechtigungen finden Sie hier:

Voraussetzungen

  • Sie müssen die API bereits in der App Engine-Standardumgebung bereitgestellt haben. Mithilfe des Befehls gcloud app deploy wird auf der Domain appspot.com automatisch ein DNS-Eintrag für die API erstellt, damit sie für das Endpoints-Portal erreichbar ist.

  • Wenn die API einen API-Schlüssel erfordert, gehen Sie so vor:

  • Wenn die API eine Authentifizierung erfordert, gehen Sie so vor:

APIs Explorer-Einstellungen konfigurieren

Wenn für Ihre API ein API-Schlüssel und/oder eine Firebase- oder Auth0-Authentifizierung erforderlich ist, müssen Sie diese Einstellungen konfigurieren, bevor Nutzer die API testen können. In diesem Abschnitt wird beschrieben, wie Sie einen API-Schlüssel und die Authentifizierungseinstellungen konfigurieren.

API-Schlüssel konfigurieren

So konfigurieren Sie einen API-Schlüssel in Ihrem Portal:

  1. Gehen Sie in der Google Cloud Console zu APIs & Dienste; Anmeldedaten.

    Zur Seite „Domainbestätigung“

  2. Wählen Sie oben im Fenster der Google Cloud Console in der Drop-down-Liste Projekt das Google Cloud-Projekt aus, in dem Sie die API erstellt haben.

    • Wenn Sie bereits einen API-Schlüssel haben, den Sie verwenden möchten, gehen Sie so vor:

      1. Klicken Sie neben dem zu verwendenden API-Schlüssel auf API-Schlüssel bearbeiten .
      2. Klicken Sie rechts neben dem API-Schlüssel auf Kopieren , um den API-Schlüssel in die Zwischenablage zu kopieren.
      3. Klicken Sie auf Abbrechen.

    • Wenn Sie einen API-Schlüssel erstellen müssen, gehen Sie so vor:

      1. Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel aus.
      2. Kopieren Sie den Schlüssel in die Zwischenablage.
      3. Klicken Sie auf Schließen.

  3. Gehen Sie zu Ihrem Portal zurück.

  4. Klicken Sie auf Einstellungen .

  5. Klicken Sie auf den Tab APIs und wählen Sie aus der Drop-down-Liste die API aus.

  6. Fügen Sie den API-Schlüssel im Abschnitt APIs Explorer-Einstellungen in das Feld Google API-Schlüssel ein.

  7. Klicken Sie auf Speichern.

Firebase konfigurieren

So konfigurieren Sie Firebase:

  1. Öffnen Sie die Firebase Console.

    • Wenn Sie noch kein Firebase-Projekt haben, gehen Sie so vor:

      1. Klicken Sie auf Projekt hinzufügen und wählen Sie den Namen des Google Cloud-Projekts aus, in dem sich die API befindet.
      2. Klicken Sie in der Karte Authentication (Authentifizierung) auf Get started (Jetzt starten).
      3. Klicken Sie auf den Tab Sign-In Method (Anmeldemethode).
      4. Aktivieren Sie im Abschnitt Sign-in providers (Anbieter für Anmeldungen) die Anbieter, die Sie verwenden möchten.
      5. Klicken Sie im Abschnitt Authorized domains (Autorisierte Domains) auf Add Domain (Domain hinzufügen) und fügen Sie den Domainnamen Ihres Portals hinzu (z. B. endpointsportal.example-api.example.com).
      6. Klicken Sie auf Web Setup (Webeinrichtung). Das benutzerdefinierte Code-Snippet wird angezeigt. Lassen Sie die Firebase Console geöffnet, da Sie in den nachfolgenden Schritten Informationen aus dem Code-Snippet benötigen.

    • Wenn Sie bereits ein Firebase-Projekt haben, gehen Sie so vor:

      1. Rufen Sie Develop > Authentication (Develop > Authentifizierung) auf.
      2. Klicken Sie auf den Tab Sign-In Method (Anmeldemethode).
      3. Klicken Sie im Abschnitt Authorized domains (Autorisierte Domains) auf Add Domain (Domain hinzufügen) und fügen Sie den Domainnamen Ihres Portals hinzu (z. B. endpointsportal.example-api.example.com).
      4. Klicken Sie auf Web Setup (Webeinrichtung). Das benutzerdefinierte Code-Snippet wird angezeigt. Lassen Sie die Firebase Console geöffnet, da Sie in den nachfolgenden Schritten Informationen aus dem Code-Snippet benötigen.

  2. Öffnen Sie im Browser einen weiteren Tab und rufen Sie das Portal auf.

  3. Klicken Sie auf Einstellungen (Einstellungen) .

  4. Klicken Sie auf der Seite Settings (Einstellungen) auf den Tab APIs und wählen Sie aus der Drop-down-Liste die API aus.

  5. Gehen Sie im Abschnitt APIs Explorer Settings (APIs Explorer-Einstellungen) so vor:

    1. Kopieren Sie aus dem Firebase-Code-Snippet den Wert des Feldes apiKey und fügen Sie ihn in das Feld Google API key (Google API-Schlüssel) ein.
    2. Kopieren Sie aus dem Firebase-Code-Snippet den Wert des Feldes authDomain und fügen Sie ihn in das Feld Firebase auth domain (Firebase Auth-Domain) ein.

  6. Klicken Sie auf Speichern.

Weitere Informationen finden Sie in der Firebase-Dokumentation.

Auth0 konfigurieren

Führen Sie zum Konfigurieren von Auth0 und Ihres Portals die folgenden Aufgaben aus.

Aufgabe 1: Prüfen Sie, ob eine Auth0 API für den Cloud Endpoints-Dienst vorhanden ist.

Aufgabe 2: Konfigurieren Sie die Einstellungen für die Auth0-Anwendung.

Aufgabe 3: Konfigurieren Sie die Auth0-Einstellungen auf Ihrem Portal.

Aufgabe 1: Prüfen Sie, ob eine Auth0 API für den Endpoints-Dienst vorhanden ist.

  1. Melden Sie sich beim Auth0-Dashboard an.

  2. Klicken Sie in der linken Navigationsleiste auf APIs. Wenn eine API-Zielgruppe in Form von https://SERVICE_NAME vorhanden und SERVICE_NAME der Name Ihres Endpoints-Dienstes ist, haben Sie bereits eine API erstellt. Fahren Sie mit der nächsten Aufgabe fort, um die Einstellungen für die Auth0-Anwendung zu konfigurieren.

    Erstellen Sie andernfalls eine API:

    1. Klicken Sie auf + Create API (+ API erstellen).
    2. Geben Sie einen Namen ein.

    3. Geben Sie im Feld Identifier (Kennung) eine URL im Format https://SERVICE_NAME ein.

      Ersetzen Sie SERVICE_NAME durch den Namen Ihres Endpoints-Dienstes. Wenn Sie den Dienstnamen nicht kennen, erfahren Sie unter Dienstname und Konfigurations-ID abrufen, wie Sie den Namen Ihres Endpoints-Dienstes erhalten.

    4. Klicken Sie auf Erstellen.

Aufgabe 2: Konfigurieren Sie die Einstellungen für die Auth0-Anwendung.

  1. Klicken Sie im Auth0-Dashboard in der linken Navigationsleiste auf Applications (Anwendungen).
  2. Wählen Sie Ihre Auth0-Anwendung aus oder klicken Sie auf + Create Application (+ Anwendung erstellen), um eine neue Anwendung zu erstellen.

  3. Scrollen Sie auf dem Tab Settings (Einstellungen) nach unten und fügen Sie im Feld Allowed Callback URLs (Zulässige Callback-URLs) die OAuth-Weiterleitungs-URL Ihres Portals ein. Die OAuth-Weiterleitungs-URL Ihres Portals ist die URL Ihres Portals plus /oauth/redirect (z. B. https://endpointsportal.example-api.example.com/oauth/redirect).

    Im Feld "Allowed Callback URLs" (Zulässige Callback-URLs) sind mehrere durch ein Komma getrennte URLs zulässig. Achten Sie darauf, dass die von Ihnen eingegebene URL keinen abschließenden Schrägstrich ("/") enthält.

  4. Klicken Sie auf Änderungen speichern.

    Lassen Sie den Browsertab Auth0 Settings (Auth0-Einstellungen) geöffnet, da Sie die dort gezeigten Informationen in den folgenden Schritten benötigen.

Aufgabe 3: Konfigurieren Sie die Auth0-Einstellungen auf Ihrem Portal.

  1. Öffnen Sie im Browser einen weiteren Tab und rufen Sie das Portal auf.
  2. Klicken Sie auf Einstellungen (Einstellungen) .
  3. Klicken Sie auf der Seite Settings (Einstellungen) auf den Tab APIs und wählen Sie aus der Drop-down-Liste die API aus.

  4. Gehen Sie im Abschnitt APIs Explorer Settings (APIs Explorer-Einstellungen) so vor:

    1. Kopieren Sie den Wert des Feldes Client ID (Client ID) aus dem Auth0-Dashboard und fügen Sie ihn in das Feld Auth0 client ID (Auth0-Client-ID) ein.
    2. Kopieren Sie den Wert des Feldes Domain aus dem Auth0-Dashboard und fügen Sie ihn in das Feld Auth0 domain (Auth0-Domain) ein.

  5. Klicken Sie auf Speichern.

Weitere Informationen zum Konfigurieren von Auth0 finden Sie in der Auth0-Dokumentation in der Auth0-Dashboard-Übersicht.