Funktionen mithilfe von Richtlinien hinzufügen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Apigee ermöglicht Ihnen, API-Verhalten zu programmieren, ohne Code zu schreiben, indem Sie policies verwenden. Eine Richtlinie ist wie ein Modul, das eine bestimmte, eingeschränkte Verwaltungsfunktion implementiert. Mithilfe von Richtlinien können Sie gängige Verwaltungsoptionen effizient und zuverlässig auf APIs anwenden.

Richtlinien bieten Funktionen wie Sicherheits-, Ratenbegrenzungs-, Transformations- und Vermittlungsfunktionen. Sie müssen dann nicht mehr Code schreiben und diesen selbst verwalten. Sie sind nicht auf die von Apigee bereitgestellten Richtlinientypen beschränkt. Sie können auch benutzerdefinierte Skripte und Code (z. B. JavaScript-Anwendungen) schreiben, die die API-Proxy-Funktionalität erweitern und es Ihnen ermöglichen, zusätzlich zu den grundlegenden Verwaltungsfunktionen, die von den Apigee-Richtlinien unterstützt werden, Innovationen einzubringen.

Erstellen und hängen Sie in API-Proxys und freigegebenen Abläufen mit Apigee in Cloud Code Richtlinien an, wie in den folgenden Abschnitten beschrieben. Je nach Richtlinientyp müssen Sie möglicherweise eine Ressource erstellen, wie unter Ressourcen verwalten beschrieben. Weitere Informationen finden Sie unter Ordner und Dateien in einem Apigee-Arbeitsbereich verwalten.

Richtlinie erstellen

So erstellen Sie eine Richtlinie mit Apigee in Cloud Code:

  1. Führen Sie in Ihrem Apigee-Arbeitsbereich eine der folgenden Aktionen aus, je nachdem, wo Sie die Richtlinie anhängen möchten:

    Hinzufügen zu Aktion
    API-Proxy Führen Sie eine der folgenden Aktionen aus:
    • Bewegen Sie den Mauszeiger auf einen der folgenden Ordner, klicken Sie auf Apigee-Richtliniensymbol erstellen und wählen Sie Richtlinie erstellen aus:
      • Proxy-Bundle apiproxy-name
      • apiproxy-name/apiproxy
    • Bewegen Sie den Mauszeiger für den API-Proxy über dem Ordner apiproxy-name/apiproxy/policies und klicken Sie auf Symbol für API-Proxy erstellen.
    Freigegebener Ablauf Führen Sie eine der folgenden Aktionen aus:
    • Bewegen Sie den Mauszeiger auf einen der folgenden Ordner, klicken Sie auf Symbol „Shared Flow erstellen“ und wählen Sie Richtlinie erstellen aus:
      • sharedflow-name freigegebenes Ablauf-Bundle
      • sharedflow-name/sharedflowbundle
    • Bewegen Sie den Mauszeiger für den freigegebenen Ablauf über den Ordner sharedflow-name/sharedflowbundle/policies und klicken Sie auf Symbol „Shared Flow erstellen“.

Der Assistent zum Erstellen von Richtlinien wird geöffnet.

  1. Wähle aus der Liste die Kategorie der Richtlinie aus, die du erstellen möchtest. Eine Beschreibung der Richtlinienkategorien finden Sie unter Übersicht über die Richtlinien.

  2. Geben Sie einen eindeutigen Namen für die Richtlinie ein und drücken Sie die Eingabetaste. Die Richtlinie wird dem Ordner /policies für den API-Proxy oder den freigegebenen Ablauf im Apigee-Bereich hinzugefügt und im Editor geöffnet.

  3. Bearbeiten Sie die Datei nach Bedarf und wählen Sie Datei > Speichern oder ⌘S aus, um Ihre Änderungen zu speichern. Weitere Informationen zur Konfiguration der Richtlinie finden Sie unter Übersicht über die Richtlinien.

  4. Erstellen Sie Ressourcen, falls dies für den Richtlinientyp erforderlich ist, wie unter Ressourcen verwalten beschrieben.

Richtlinie zu einem Ablauf hinzufügen

Richtlinien werden erst ausgeführt, wenn sie einem Ablauf zugeordnet sind. Sie können eine Richtlinie an einen Ablauf anhängen, indem Sie das Element <Step> dem entsprechenden Anfrage- oder Antwortablaufelement in einer ProxyEndpoint- oder TargetEndpoint-Konfiguration hinzufügen, wie in den folgenden Themen beschrieben:

Die folgende Konfiguration hängt beispielsweise eine QuotaPolicy an das <PreFlow> des ProxyEndpoint an, um die Anzahl der Anfragenachrichten zu konfigurieren, die ein API-Proxy in einem bestimmten Zeitraum zulässt.

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>QuotaPolicy</Name></Step>
    </Request>
  </PreFlow>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
  </HTTPProxyConnection>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>