Schritt 4: API testen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Zum Testen der bereitgestellten helloworld API klicken Sie in Apigee in Cloud Code auf den Tab Terminal und geben den folgenden curl-Aufruf ein:

curl 0:8998/helloworld

Die folgende Fehlermeldung wird angezeigt:

Aufrufen der API im Terminal-Tab und Abrufen eines Autorisierungsfehlers

Da Sie beim Erstellen des API-Proxys die API-Schlüsselauthentifizierung aktiviert haben, müssen Sie beim Aufruf der API einen API-Schlüssel mit dem Suchparameter apikey übergeben.

Um einen API-Schlüssel zu erhalten, müssen Sie ein Test-Bundle erstellen und die folgenden Testressourcen konfigurieren:

  • API-Produkt, mit dem die API gebündelt und für Entwickler verfügbar gemacht wird.

  • Entwickler, der eine App für den Zugriff auf die API erstellt.

  • Entwickler-App, die über einen API-Schlüssel den Zugriff auf die API ermöglicht.

Testressourcen erstellen und exportieren

  1. Erstellen Sie ein Test-Bundle:
    1. Bewegen Sie den Mauszeiger auf den Ordner tests und klicken Sie auf Symbol für Test-Bundle erstellen.

      + wird angezeigt, wenn Sie den Mauszeiger auf den Testordner bewegen.

      Der Assistent zum Erstellen eines Test-Bundles wird geöffnet.

    2. Geben Sie als Testnamen mytestbundle ein und drücken Sie die Eingabetaste.

      Das Test-Bundle wird erstellt.

    3. Maximieren Sie den Ordner mytestbundle, um sich dessen Inhalt anzusehen.

      Testordner mit Dateien für developerapps.json, developers.json, maps.json und products.json

  2. API-Produkttestressource konfigurieren:
    1. Bewegen Sie den Mauszeiger auf die Datei products.json und klicken Sie auf Symbol für API-Produkt erstellen.

      + wird angezeigt, wenn Sie den Mauszeiger über "products.json" positionieren.

      Der Assistent zum Erstellen einer API-Produkt wird geöffnet.

      Erste Seite des Assistenten zum Erstellen eines API-Produkts

    2. Geben Sie meinprodukt für den Namen des API-Produkts ein und drücken Sie die Eingabetaste, um den Vorgang zu bestätigen und fortzufahren.
    3. Geben Sie myproduct ein, um die Beschreibung des API-Produkts einzugeben, und drücken Sie die Eingabetaste, um den Vorgang zu bestätigen und fortzufahren.
    4. Wählen Sie helloworld aus, um den API-Proxy zum API-Produkt hinzuzufügen, und klicken Sie auf OK.

      Die Datei products.json wird im Editor geöffnet, während das neue API-Produkt konfiguriert ist:

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "scopes": [],
          "environments": [],
          "apiResources": [
            "/",
            "/*",
            "/**"
          ],
          "quota": "100",
          "quotaInterval": "1",
          "quotaTimeUnit": "minute",
          "name": "myproduct",
          "displayName": "myproduct",
          "proxies": [
            "helloworld"
          ]
        }
      ]
  3. Konfigurieren Sie die Entwickler-Testressource:
    1. Bewegen Sie den Mauszeiger auf die Datei developers.json und klicken Sie auf Apigee-Entwicklersymbol erstellen.

      + wird angezeigt, wenn Sie den Cursor über developers.json platzieren.

      Der Assistent zum Erstellen von Entwicklern wird geöffnet.

      Erste Seite des Assistenten zum Erstellen eines API-Produkts

    2. Geben Sie die folgenden Werte in die Eingabeaufforderung ein und drücken Sie zur Bestätigung die Eingabetaste:
      • E-Mail-Adresse des Entwicklers: ahamilton@example.com
      • Nutzername: ahamilton
      • Vorname: Alex
      • Nachname: Hamilton

      Die Datei developers.json wird im Editor mit dem neuen Entwickler geöffnet:

      [
          {
            "attributes": [
              {
                "name": "sample_attribute_0",
                "value": "sample_attribute_value_0"
              }
            ],
            "email": "ahamilton@example.com",
            "userName": "ahamilton",
            "firstName": "Alex",
            "lastName": "Hamilton"
          }
        ]
  4. Konfigurieren Sie die Testressource für die Entwickler-App:
    1. Bewegen Sie den Mauszeiger auf die Datei developerapps.json und klicken Sie auf Symbol für Entwickler-App erstellen.

      + wird angezeigt, wenn Sie den Mauszeiger über "developerapps.json" positionieren.

      Der Assistent für Entwickler-App wird geöffnet.

      Erste Seite des Assistenten zum Erstellen eines API-Produkts

    2. Wählen Sie ahamilton@example.com als Inhaber der App aus.
    3. Geben Sie beim nächsten Satz von Eingabeaufforderungen die folgenden Werte ein und bestätigen Sie mit den Eingabetaste:
      • App-Name: myapp
      • Beschreibung: myapp
      • Callback-URL: leer lassen
      • Wählen Sie myproduct aus, um das Produkt zur App hinzuzufügen, und klicken Sie auf OK.
      • Wählen Sie als Ablaufwert Nie aus.

      Die Datei developerapps.json wird im Editor mit der neuen Anwendung geöffnet:

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "developerEmail": "ahamilton@example.com",
          "name": "myapp",
          "displayName": "myapp",
          "callbackUrl": "",
          "apiProducts": [
            "myproduct"
          ],
          "expiryType": "never"
        }
      ]
  5. Exportieren Sie die Testressourcen in den Apigee Emulator.

    Bewegen Sie den Mauszeiger auf das Test-Bundle mytestbundle und klicken Sie auf Symbol „Testressourcen exportieren“.

    Aktive Testressourcen wie API-Produkte, Entwickler und Entwickler-Apps

    Die aktiven Testressourcen werden im Abschnitt "Apigee-Emulatoren" angezeigt, wie in der folgenden Abbildung dargestellt.

    Aktive Testressourcen wie API-Produkte, Entwickler und Entwickler-Apps

API-Schlüssel abrufen

Rufen Sie die Anmeldedaten für den API-Schlüssel für Ihre Entwickleranwendung ab:

  1. Klicken Sie im Bereich Emulatoren unter Aktive Testdaten auf Aktive Entwickler-Apps.

    Die aktive Konfigurationsdatei für Entwickler-Apps wird im Editor geöffnet. Die Datei enthält Anmeldedaten für myproduct, wie in der folgenden Abbildung dargestellt.

    <p><img src="/apigee/docs/api-platform/images/vscode-consumerkey.png" alt="Developer apps with the consumerKey value highlighted."></p>
    

  2. Kopieren Sie den Wert consumerKey (ohne Anführungszeichen) für das API-Produkt myproduct.

Die API testen

So testen Sie die API mit dem API-Schlüssel:

  1. Übergeben Sie den API-Schlüssel in Ihrem curl-Aufruf mit dem Suchparameter apikey so:
    curl 0:8998/helloworld?apikey=API_KEY

    Die folgende Antwort wird zurückgegeben

    Hello, Guest!

Das wars! Sie haben eine API in Ihrer lokalen Umgebung erfolgreich ausgeführt.

Im nächsten Schritt erfahren Sie, wie Sie den Zielendpunkt ändern können.

1 2 3 4 (NÄCHSTER) Schritt  5: Zielendpunkt ändern 6 7 8