API-Proxy erstellen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Hinweis: In Umgebungen, für die Archiv-Deployments aktiviert sind, können Sie keine API-Proxys mithilfe der Apigee-UI, der API oder mit gcloud entwickeln. Informationen zum Erstellen von API-Proxys für Archiv-Deployments mit Apigee in VS Code finden Sie unter API-Proxys mit Apigee in VS Code entwickeln.

Erstellen Sie einen Proxy in der Apigee-Benutzeroberfläche oder mithilfe der API, wie in den folgenden Abschnitten beschrieben.

Hauptfelder für API-Proxy

Beachten Sie beim Erstellen eines API-Proxy die folgenden Richtlinien:

Feld	Beschreibung
Name des API-Proxys	Für Ihre API angezeigter Name. Geben Sie alphanumerische Zeichen, einen Bindestrich (-) oder Unterstrich (_) ein. Hinweis: Der Name des API-Proxys darf nicht mit dem Namen eines API-Proxys in der Organisation übereinstimmen, der in einer Umgebung mit aktivierter Proxybereitstellung bereitgestellt werden kann.
Basispfad des API-Proxys	URI-Fragment, das nach der Adresse http://[host] oder https://[host] des API-Proxys angezeigt wird. Apigee verwendet den Basispfad-URI, um eingehende Anfragenachrichten mit dem passenden API-Proxy abzugleichen und zu diesem weiterzuleiten. Hinweis: Der Basispfad muss eindeutig sein. Sie können nicht zwei API-Proxys mit demselben Basispfad bereitstellen. Wenn Sie einen bereitgestellten API-Proxy bearbeiten und den Basispfad auf denselben Wert wie den Basispfad eines anderen API-Proxys festlegen, wird die Bereitstellung des API-Proxys beim Speichern automatisch von Apigee aufgehoben. Bevor Sie den API-Proxy wieder bereitstellen können, müssen Sie den Basispfad so ändern, dass er eindeutig ist. Platzhalter in Basispfaden verwenden Verwenden Sie einen oder mehrere Platzhalter in API-Proxy-Basispfaden, um Ihre API-Proxys zukunftssicher zu machen. Es ist zulässig, ein einzelnes Platzhalterzeichen * zwischen zwei Schrägstrichen / anzugeben: /*/. Mit dem Basispfad /team/*/members können Clients beispielsweise https://[host]/team/blue/members und https://[host]/team/green/members aufrufen, ohne neue API-Proxys für die Unterstützung neuer Teams erstellen zu müssen. Sie können eine beliebige Anzahl von Tokens im Basispfad nach diesem Muster ersetzen. Andere Muster, einschließlich /**, /something* oder /*something, werden nicht unterstützt.
Beschreibung	Optional: Eine Beschreibung für den API-Proxy.
Ziel-/Backend-Ziel-URL	URL (einschließlich HTTP oder HTTPS) des Back-End-Dienstes, der von diesem API-Proxy aufgerufen wird.

Schritte zum Erstellen eines API-Proxy

So erstellen Sie einen API-Proxy über die Benutzeroberfläche oder APIs:

Apigee in der Cloud Console

So erstellen Sie einen Proxy in Apigee in der Cloud Console:

1. Öffnen Sie die Apigee-UI in der Cloud Console in einem Browser.
   Hinweis: Wenn die Seite Willkommen bei der Apigee API-Verwaltung angezeigt wird, müssen Sie Ihre Apigee-Organisation bereitstellen, bevor Sie fortfahren.

   Nachdem Sie Apigee bereitgestellt haben, schließen Sie die UI und öffnen Sie die Apigee-UI in der Cloud Console noch einmal.

2. Klicken Sie im linken Navigationsbereich auf Proxy-Entwicklung > API-Proxys.
3. Klicken Sie im Bereich API-Proxys auf + Erstellen.
4. Wählen Sie im Bereich Proxy erstellen unter Proxy-Vorlage die Option Reverse-Proxy (häufigste Quelle) aus.
5. Geben Sie unter Proxydetails Folgendes ein:
   • Proxyname: Geben Sie einen Namen für den Proxy ein, z. B. myproxy.
   • Basispfad: Wird automatisch auf den Wert festgelegt, den Sie für Proxy name eingeben. Der Basispfad ist Teil der URL, die zum Senden von Anfragen an Ihre API verwendet wird. Apigee verwendet die URL, um eingehende Anfragen zuzuordnen und an den richtigen API-Proxy weiterzuleiten.
   • Beschreibung (Optional): Geben Sie eine Beschreibung für den neuen API-Proxy ein, z. B. „Apigee mit einem einfachen Proxy testen“.
   • Ziel (vorhandene API): Geben Sie https://mocktarget.apigee.net ein. Dies definiert die Ziel-URL, die Apigee für eine Anfrage an den API-Proxy aufruft. Der simulierte Zieldienst wird bei Apigee gehostet und gibt einfache Daten zurück. Ein API-Schlüssel oder ein Zugriffstoken sind nicht erforderlich.
   • Klicken Sie auf Weiter.
6. Bereitstellen (optional):
   • Bereitstellungsumgebungen: Optional. Wählen Sie durch die Kästchen eine oder mehrere Umgebungen aus, in denen Sie Ihren Proxy bereitstellen möchten. Wenn Sie den Proxy zu diesem Zeitpunkt nicht bereitstellen möchten, lassen Sie das Feld Bereitstellungsumgebungen leer. Sie können den Proxy später jederzeit bereitstellen.
   • Dienstkonto: (optional) Hängen Sie ein Dienstkonto an Ihre Bereitstellung an, damit der Proxy auf Google Cloud-Dienste zugreifen kann, wie in der Rolle und den Berechtigungen des Dienstkontos angegeben.
7. Klicken Sie auf Erstellen.

Apigee erstellt den neuen Proxy und zeigt eine Zusammenfassung der Proxydetails in der Ansicht Proxy-Zusammenfassung an.

Wenn Sie den Proxy bereitstellen, wird im Abschnitt Bereitstellungen die Nummer der Überarbeitung angezeigt, die 1 ist, wenn Sie das erste Mal bereitstellen. In der Spalte Status werden mit einer grünen Statusanzeige die Umgebungen angezeigt, in denen der Proxy bereitgestellt wird.

Klassisches Apigee

So erstellen Sie einen einfachen API-Proxy in der klassischen Apigee-Benutzeroberfläche:

1. Melden Sie sich bei der Apigee-UI an.
2. Klicken Sie in der Hauptansicht auf API-Proxys.
3. Wählen Sie in der Drop-down-Liste Umgebung die Umgebung aus, in der Sie einen neuen API-Proxy erstellen möchten.

   Die Hybrid-Benutzeroberfläche zeigt eine Liste der API-Proxys für diese Umgebung an. Wenn Sie noch keine Proxys erstellt haben, ist die Liste leer.

4. Klicken Sie auf Neu erstellen.

   Der Assistent zum Erstellen von Proxys wird gestartet.

5. Klicken Sie auf Proxy umkehren (am häufigsten).

   

   Die Seite Proxy-Details wird angezeigt.

6. Konfigurieren Sie den Proxy mit den folgenden Einstellungen:
   • Name: Geben Sie getstarted ein. Wenn bereits ein Proxy mit diesem Namen vorhanden ist, wählen Sie einen anderen Namen.
   • Basispfad: Behalten Sie die Einstellung /getstarted bei. Der Basispfad ist Teil der URL, die zum Senden von Anfragen an Ihre API verwendet wird. Apigee verwendet die URL, um eingehende Anfragen zuzuordnen und an den richtigen API-Proxy weiterzuleiten.
   • Beschreibung (optional): Geben Sie eine Beschreibung für Ihren neuen API-Proxy ein, z. B. Get started API proxy.
   • Ziel (vorhandene API): Geben Sie https://mocktarget.apigee.net ein. Dies definiert die Ziel-URL, die Apigee für eine Anfrage an den API-Proxy aufruft. Der simulierte Zieldienst wird bei Apigee gehostet und gibt einfache Daten zurück. Ein API-Schlüssel oder ein Zugriffstoken sind nicht erforderlich.

   Die Details Ihres API-Proxys sollten so aussehen:

   

7. Klicken Sie auf Weiter.
8. Wählen Sie in der Ansicht Allgemeine Richtlinien unter Sicherheit: Autorisierung die Option Passthrough (keine Autorisierung) aus.

   

9. Klicken Sie auf Weiter.
10. Wählen Sie auf der Seite Zusammenfassung die gewünschte Umgebung aus und klicken Sie auf Erstellen und bereitstellen.

    

    Hinweis: Wenn Sie unter Optionales Deployment keine Umgebung auswählen, wird die Schaltfläche rechts unten mit der Bezeichnung Erstellen angezeigt.
    Hinweis: Nachdem Sie eine API-Proxy-Überarbeitung bereitgestellt haben, können Sie diese nicht mehr bearbeiten. Um den API-Proxy zu bearbeiten, müssen Sie eine neue Überarbeitung erstellen und bereitstellen.

    Aus diesem Grund können Sie den API-Proxy erstellen, ohne ihn in einer Umgebung bereitzustellen. Sie können den API-Proxy bearbeiten und später bereitstellen, wie unter Tipp beschrieben.

    Der neue API-Proxy wird erstellt und in der ausgewählten Umgebung bereitgestellt.

    

11. Klicken Sie auf Proxy bearbeiten, um den Tab "Übersicht" im Proxy-Editor aufzurufen.

In der Liste der API-Proxys ist der Bereitstellungsstatus des API-Proxys getstarted für die Umgebung test grün.

Apigee API

Erstellen Sie einen API-Proxy in Ihrer Apigee-Organisation, indem Sie eine POST-Anfrage an die folgende Ressource senden:

https://apigee.googleapis.com/v1/organizations/$ORG/apis

Sie müssen den Namen des API-Proxys mit dem Abfrageparameter name definieren. Die im Namen verwendeten Zeichen sollten auf folgende begrenzt sein: A-Za-z0-9._\-$ %

Optional können Sie ein API-Proxy-Konfigurationsset mit den folgenden Schritten importieren:

• Setzen Sie den Abfrageparameter action auf import.
• Setzen Sie den Content-type-Header auf multipart/form-data.
• Übergeben Sie den Namen des API-Proxy-Konfigurationssets auf Ihrem lokalen Dateisystem.

Das folgende Beispiel zeigt, wie Sie einen API-Proxy erstellen, indem Sie mithilfe der API ein API-Proxy-Konfigurations-Bundle (helloworld-config.zip) in Ihr lokales Dateisystem importieren.

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

Dabei ist $TOKEN auf Ihr OAuth 2.0-Zugriffstoken festgelegt. Weitere Informationen hierzu finden Sie unter OAuth 2.0-Zugriffstoken abrufen. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der verwendeten Umgebungsvariablen findet sich unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe:

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

Weitere Informationen zum Erstellen eines API-Proxys finden Sie in der Apigee API unter der Methode apis.create. Alle für API-Proxys verfügbaren Methoden finden Sie unter API Proxies API.

Nächste Schritte

Nachdem Sie einen einfachen API-Proxy erstellt haben, führen Sie in der Regel einen der folgenden Schritte aus:

• Fügen Sie Richtlinien, Sicherheit und andere Features der Apigee-Plattform hinzu, wie unter Grundlegendes zu APIs und API-Proxys beschrieben.
• Stellen Sie das Feature in Ihrem Cluster bereit, wie unter API-Proxy bereitstellen beschrieben.