API-Proxys entwickeln

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Sie können APIs auf Apigee verfügbar machen, indem Sie API-Proxys implementieren. API-Proxys entkoppeln die App-seitige API von Ihren Back-End-Diensten, sodass diese Apps von Änderungen am Back-End-Code abgeschirmt sind.

Entwickeln Sie Ihre API-Proxys mithilfe von Apigee in Cloud Code, wie in den folgenden Abschnitten beschrieben. Weitere Informationen finden Sie unter Ordner und Dateien in einem Apigee-Arbeitsbereich verwalten.

API-Proxy erstellen

So erstellen Sie einen API-Proxy mit Apigee in {code_name}}:

  1. Führen Sie eine der folgenden Aktionen aus:

    • Bewegen Sie den Mauszeiger im Apigee-Bereich auf den Ordner apiproxies und klicken Sie auf Symbol "Erstellen".

      + wird angezeigt, wenn Sie den Cursor über dem Ordner "API-Proxys" platzieren.

    • Wählen Sie Ansicht > Befehlspalette aus, um die Befehlspalette zu öffnen, und wählen Sie Cloud Code: Create Apigee proxy bundle aus.

    Der Create Proxy-Assistent wird geöffnet.

  2. Wählen Sie eine der folgenden Optionen aus:

    Typ Beschreibung
    Reverse proxy

    Ein API-Proxy, der eingehende Anfragen an vorhandene HTTP-Back-End-Dienste weiterleitet. Dies kann eine JSON- oder XML API sein. Weitere Informationen finden Sie weiter unten in diesem Abschnitt unter Reverse Proxy für einen HTTP-Dienst erstellen.
    No target

    Ein API-Proxy ohne API-Back-End ("kein Ziel"). Ähnlich wie beim Erstellen eines Reverse-Proxys für einen HTTP-Dienst, mit dem Unterschied, dass Sie beim Definieren der API-Proxy-Details keine vorhandene Ziel-URL angeben.

In den folgenden Abschnitten werden zusätzliche Schritte beschrieben, die zum Erstellen der einzelnen API-Proxy-Typen erforderlich sind.

Reverse-Proxy für einen HTTP-Dienst erstellen

Apigee generiert Reverse-Proxys anhand der folgenden Informationen:

  • URL des Back-End-Dienstes
  • URI-Pfad, durch den sich die API eindeutig identifizieren lässt, die vom API-Proxy für Verbraucheranwendungen verfügbar gemacht wird.

Wenn Sie beim Erstellen eines API-Proxys die Option Umgekehrter Proxy auswählen, werden Sie aufgefordert, die Sicherheitsauthentifizierung und die API-Proxy-Details einzugeben, wie in den folgenden Tabellen beschrieben.

Wählen Sie für die Sicherheitsauthentifizierung eine der folgenden Optionen aus:

Sicherheitsauthentifizierung Beschreibung
API key based authentication

Fügt dem von Ihnen definierten API-Proxy eine einfache API-Schlüsselüberprüfung hinzu. Apigee fügt Ihrem API-Proxy automatisch die folgenden Richtlinien hinzu:

  • VerifyAPIKey, um API-Schlüssel zu validieren, die durch das Anfordern von Anwendungen bereitgestellt werden.
  • AssignMessage, um den API-Schlüssel, der im API-Aufruf als Abfrageparameter übergeben wird, aus der Anfrage an den Back-End-Server zu entfernen.
Access token based authentication

Fügt Ihrem OAuth-Proxy eine OAuth 2.0-basierte Authentifizierung hinzu. Apigee fügt Ihrem API-Proxy automatisch die folgenden Richtlinien hinzu:

  • VerifyAPIKey, um das Zugriffstoken zu verifizieren.
  • AssignMessage, um den Authorization-Header zu entfernen, der zur Authentifizierung übergeben wird.
Weitere Informationen zur Authentifizierung mit Zugriffstokens finden Sie unter Zugriffstokens prüfen.
No authentication Keine Authentifizierung erforderlich. Anfragen werden ohne Sicherheitsprüfungen von Apigee an das Back-End weitergeleitet.

Beantworten Sie für Details zum API-Proxy, jede der folgenden Aufforderungen und drücken Sie die Eingabetaste um zu bestätigen und fortzufahren, oder Esc, um den Assistenten abzubrechen:

Feld Beschreibung
Backend target URL URL des Back-End-Dienstes, der von diesem API-Proxy aufgerufen wird.
API proxy name Für Ihre API angezeigter Name. Geben Sie alphanumerische Zeichen, einen Bindestrich (-) oder Unterstrich (_) ein.
API proxy base path 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.

Platzhalter in Basispfaden verwenden

Verwenden Sie einen oder mehrere /*/-Platzhalter in API-Proxy-Basispfaden, um Ihre API-Proxys zukunftssicher zu machen. 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. Beachten Sie, dass /**/ nicht unterstützt wird.

Nachdem Sie die Schritte im Assistenten abgeschlossen haben, wird der neue apiproxy-name-Ordner unter apiproxies dem Apigee-Bereich hinzugefügt. Jeder API-Proxy-Ordner ist wie in der API-Proxy-Konfigurationsverzeichnisstruktur beschrieben.

Im Folgenden finden Sie ein Beispiel für die Standardkonfiguration, die für einen Reverse API-Proxy namens helloworld erstellt wurde, wobei Richtlinien hinzugefügt werden, die eine API-schlüsselbasierte Authentifizierung unterstützen.

Zeigt die Ordnerstruktur eines Reverse-Proxys im Apigee-Bereich an.

Eine Beschreibung der Standardkonfiguration finden Sie unter Standard-API-Proxy-Konfiguration kennenlernen.

API-Proxy ohne Back-End-Ziel erstellen

Wenn Sie einen API-Proxy ohne Back-End-Ziel erstellen, gehen Sie genauso vor wie beim Erstellen eines Reverse Proxys, mit der Ausnahme, dass Sie nicht aufgefordert werden, eine URL für den Back-End-Dienst (Target (Existing API)) anzugeben, und die Standardkonfiguration des Zielendpunkts ist nicht enthalten. Weitere Informationen finden Sie unter Reverse-Proxy für einen HTTP-Dienst erstellen.

Die Standardkonfiguration des API-Proxys kennenlernen

In der folgenden Tabelle werden die Inhalte der Standardkonfiguration zusammengefasst, wenn Sie einen API-Proxy erstellen, der auf dem ausgewählten API-Proxy-Typ und den ausgewählten Authentifizierungsoptionen basiert.

Konfigurationsdatei umgekehrter Proxy
Umgekehrter Proxy
 Kein Ziel
OAuthV2-Authentifizierung
Authentifizierung von API-Schlüsseln
proxies/default.xml
Standard-Proxy-Endpunkt-Konfiguration.
   
targets/default.xml
Standardkonfiguration des Zielendpunkts.
     
impose-quota.xml
Kontingentrichtlinie, um ein Standardkontingent festzulegen.		    
remove-header-authorization.xml
AssignMessage-Richtlinie zum Entfernen des Authorization-Headers, der für die Authentifizierung übergeben wird.		    
 
remove-query-param-apikey.xml
AssignMessage-Richtlinie zum Entfernen des apikey-Abfrageparameters, der zur Authentifizierung übergeben wird.		      
verify-api-key.xml
VerifyAPIKey-Richtlinie zur Bestätigung der API-Schlüssel.		      
verify-oauth-v2-access-token.xml
OAuthV2-Richtlinie zur Validierung von OAuth V2-Zugriffstoken.		    
 

API-Proxy-Bundle hochladen

So laden Sie ein API-Proxy-Bundle in Cloud Code in Apigee hoch:

  1. Führen Sie eine der folgenden Aktionen aus:

    • Bewegen Sie den Mauszeiger im Apigee-Bereich auf den Ordner apiproxies und klicken Sie auf Uploadsymbol.

    • Wählen Sie Ansicht > Befehlspalette aus, um die Befehlspalette zu öffnen, und wählen Sie Cloud Code: Import Apigee proxy bundle aus.

  2. Wechseln Sie zu dem API-Proxy-Bundle, das Sie hochladen möchten, und klicken Sie auf Proxy importieren. Das API-Proxy-Bundle muss wie unter API-Proxy-Konfigurationsverzeichnisstruktur beschrieben strukturiert sein.

  3. Optional: Standardmäßig wird der Name der ZIP-Datei ohne die Erweiterung für den Namen des API-Proxys verwendet. Wenn dieser Name nicht eindeutig ist, werden Sie aufgefordert, einen eindeutigen Namen einzugeben.

Der hochgeladene Ordner apiproxy-name wird im Apigee-Bereich unter apiproxies hinzugefügt.

Proxy-Endpunkte verwalten

Wie unter Was ist ein API-Proxy? dargestellt, definiert ein Proxyendpunkt (ProxyEndpoint), wie Client-Apps Ihre APIs verwenden. Sie konfigurieren den Proxyendpunkt, um die URL Ihres API-Proxys zu definieren. Der Proxy-Endpunkt bestimmt auch, ob Anwendungen über HTTP oder HTTPS auf den API-Proxy zugreifen. Sie können dem Proxy-Endpunkt Richtlinien anhängen, um die Sicherheit, Kontingentprüfungen und andere Arten von Zugriffssteuerung und Ratenbegrenzung zu erzwingen.

Erstellen und konfigurieren Sie Proxy-Endpunkte wie in den folgenden Abschnitten beschrieben.

Proxy-Endpunkte erstellen

Wenn Sie einen API-Proxy erstellen, wird der API-Proxy-Konfiguration ein Standard-Proxy-Endpunkt hinzugefügt. Weitere Informationen finden Sie unter Standard-API-Proxy-Konfiguration kennenlernen. Sie können bei Bedarf zusätzliche Proxy-Endpunkte erstellen.

So erstellen Sie einen Proxy-Endpunkt mit Apigee in Cloud Code:

  1. Führen Sie im Apigee-Bereich eine der folgenden Aktionen aus:

    • Bewegen Sie den Mauszeiger im Apigee-Bereich in einem der folgenden Ordner, klicken Sie auf Symbol "Erstellen" und wählen Sie Proxy-Endpunkt erstellen aus:
      • Proxy-Bundle apiproxy-name
      • apiproxy-name/apiproxy
    • Zeigen Sie im Apigee-Bereich mit dem Mauszeiger auf den Ordner apiproxy-name/apiproxy/proxies und klicken Sie auf Symbol "Erstellen".

    Der Assistent zum Erstellen eines Proxy-Endpunkts wird geöffnet.

  2. Geben Sie die Werte für die nächsten Eingabeaufforderungen ein. Drücken Sie nach jeder Eingabe die Eingabetaste, um die Aktion zu bestätigen, und fahren Sie mit Esc fort.

    Feld Beschreibung
    Proxy endpoint name Zur Identifizierung des Proxy-Endpunkts verwendeter Name.
    API proxy base path Ein Teil der URL, die für Anfragen an Ihre API verwendet wird. Apigee verwendet die URL, um eingehende Anfragen zuzuordnen und an den richtigen API-Proxy weiterzuleiten.

Der Endpunkt wird erstellt, dem Ordner apiproxy-name/apiproxy/proxies im Apigee-Bereich hinzugefügt und im Editor geöffnet. Konfigurieren Sie den Proxy-Endpunkt, wie im folgenden Abschnitt beschrieben.

Proxy-Endpunkte konfigurieren

Informationen zum Konfigurieren von Proxy-Endpunkten finden Sie in den folgenden Abschnitten:

Zielendpunkte verwalten

Wie unter Was ist ein API-Proxy? beschrieben, definiert ein Zielendpunkt (TargetEndpoint) die Art der Interaktion des API-Proxys mit Ihren Back-End-Diensten. Sie konfigurieren den TargetEndpoint so, dass Anfragen an den richtigen Back-End-Dienst weitergeleitet werden, einschließlich der Festlegung von Sicherheitseinstellungen, HTTP- oder HTTPS-Protokoll und anderen Verbindungsinformationen. Sie können dem TargetEndpoint Richtlinien hinzufügen, damit die Antwortnachrichten für die Anwendung, die die ursprüngliche Anfrage gesendet hat, ordnungsgemäß formatiert sind.

Erstellen und konfigurieren Sie Zielendpunkte, wie in diesem Abschnitt beschrieben.

Zielendpunkte erstellen

Wenn Sie einen umgekehrten API-Proxy erstellen, wird der API-Proxy-Konfiguration ein Standard-Zielendpunkt hinzugefügt. Wenn Sie einen API-Proxy ohne Back-End-Ziel erstellen, wird nur der Standard-Proxyendpunkt der API-Proxy-Konfiguration hinzugefügt, kein Zielendpunkt. Weitere Informationen finden Sie unter Standard-API-Proxy-Konfiguration kennenlernen.

Erstellen Sie nach Bedarf Zielendpunkte.

So erstellen Sie einen Zielendpunkt mit Apigee in Cloud Code:

  1. Führen Sie im Apigee-Bereich eine der folgenden Aktionen aus:

    • Bewegen Sie den Mauszeiger im Apigee-Bereich auf einen der folgenden Ordner, klicken Sie auf Symbol "Erstellen" und wählen Sie Zielendpunkt erstellen aus:
      • Proxy-Bundle apiproxy-name
      • apiproxy-name/apiproxy
    • Zeigen Sie im Apigee-Bereich mit dem Mauszeiger auf den Ordner apiproxy-name/apiproxy/targets und klicken Sie auf Symbol "Erstellen".

    Der Assistent zum Erstellen eines Zielendpunkts wird geöffnet.

  2. Führen Sie je nach Typ des zu erstellenden Zielendpunkts die folgenden Schritte aus:

    Typ Schritte
    Externes HTTP(s)-Ziel

    So definieren Sie ein externes HTTP(s)-Ziel:

    1. Wählen Sie HTTP(s) target (HTTP(s)-Ziel) aus.
    2. Geben Sie den Namen des Zielendpunkts in Name des Zielendpunkts ein.
    3. Geben Sie die URL des Back-End-Dienstes ein, der dieser Zielendpunkt in Back-End-Ziel-URL aufruft.

    Weitere Informationen finden Sie unter URL des Zielendpunkts ermitteln.

    Proxy-Verkettung

    So definieren Sie einen lokal bereitgestellten API-Proxy als Ziel:

    1. Wählen Sie Proxy-Verkettung aus.
    2. Geben Sie den Namen des Zielendpunkts in Name des Zielendpunkts ein.
    3. Wählen Sie einen API-Proxy aus.
    4. Wählen Sie den Proxy-Endpunkt aus.

    Weitere Informationen finden Sie unter Gemeinsame Proxys zusammensetzen.

    Load-Balancing-Ziel

    So definieren Sie ein Ziel mit Load-Balancing mithilfe von in der Umgebung definierten Zielservern:

    1. Wählen Sie Load-Balancing-Ziel aus.
    2. Geben Sie den Namen des Zielendpunkts in Name des Zielendpunkts ein.

    Weitere Informationen finden Sie unter TargetEndpoint für das Load-Balancing von benannten TargetServern konfigurieren.

Der Zielendpunkt wird erstellt, dem Ordner apiproxy-name/apiproxy/targets im Apigee-Bereich hinzugefügt und im Editor geöffnet. Konfigurieren Sie den Zielendpunkt, wie im folgenden Abschnitt beschrieben.

Zielendpunkte konfigurieren

Konfigurieren Sie Zielendpunkte, wie in den folgenden Themen beschrieben.