Was ist eine Richtlinie?

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. Dazu verwenden Sie Richtlinien. Eine Richtlinie ist wie ein Modul, das eine bestimmte, eingeschränkte Verwaltungsfunktion implementiert. Mithilfe von Richtlinien können Sie gängige Verwaltungsoptionen einfach und zuverlässig auf APIs anwenden. Richtlinien bieten Funktionen wie Sicherheits-, Ratenbegrenzungs-, Transformations- und Vermittlungsfunktionen. Sie müssen dann nicht mehr Code schreiben und diese Funktionen 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.

In diesem Thema erhalten Sie einen Überblick über die Richtlinientypen und ihre Verwendung in Apigee. Informationen zu bestimmten Richtlinien finden Sie in der Übersicht: Richtlinienreferenzen.

Richtlinientypen und ‑kategorien

Technisch gesehen ist eine Richtlinie eine XML-formatierte Konfigurationsdatei. Die Struktur einer jeden Richtlinie (z. B. die erforderlichen und optionalen Konfigurationselemente) wird durch ein XML-Schema definiert. Wenn Sie mit XML-Tools vertraut sind, sollten Sie sich mit den Richtlinienschemas in den API-Plattformbeispielen auf GitHub vertraut machen.

Apigee-Richtlinien werden in die folgenden funktionalen Kategorien unterteilt. Die für die einzelnen Richtlinienkategorien verfügbaren Richtlinien sind in der Übersicht: Richtlinienreferenzen aufgeführt.

Trafficverwaltung

Mit Richtlinien in der Kategorie "Trafficverwaltung" können Sie den Flow von Anfrage- und Antwortnachrichten über einen API-Proxy steuern. Diese Richtlinien unterstützen die Kontrolle auf Betriebs- und Geschäftsebene. Sie haben die Kontrolle über den Rohdurchsatz und können den Traffic für einzelne Apps steuern. Durch Richtlinientypen für die Trafficverwaltung können Sie Kontingente durchsetzen und damit Denial-of-Service-Angriffe verringern.

Sicherheit

Richtlinien in der Sicherheitskategorie unterstützen Authentifizierung, Autorisierung und inhaltsbasierte Sicherheit.

Mediation

Mit Richtlinien in der Kategorie Mediation können Sie Nachrichten aktiv bearbeiten, wenn sie durch API-Proxys fließen. Sie können damit Nachrichtenformate von XML in JSON (und umgekehrt) oder ein XML-Format in ein anderes XML-Format umwandeln. Außerdem können Sie Nachrichten parsen, neue Nachrichten generieren und die Werte ausgehender Nachrichten ändern. Mediationsrichtlinien interagieren auch mit grundlegenden Diensten von Apigee, sodass Sie Daten zu Anwendungen, Entwicklern, Sicherheitstokens und API-Produkten zur Laufzeit abrufen können.

Erweiterung

Mit Richtlinien in der Kategorie Erweiterung können Sie die Erweiterbarkeit von Apigee nutzen, um benutzerdefiniertes Verhalten in der Programmiersprache Ihrer Wahl zu implementieren.

Richtlinien anhängen

Damit eine Richtlinie auf Ihren API-Proxy angewendet werden kann, müssen Sie sie dem Proxy in einem Flow anhängen. Weitere Informationen finden Sie in den anderen Themen in diesem Abschnitt, z. B. unter Richtlinien in der Benutzeroberfläche anhängen und konfigurieren und Richtlinien in XML-Dateien anhängen und konfigurieren.

Richtlinienänderungen bereitstellen

Damit die Richtlinienänderungen wirksam werden, müssen Sie die API-Proxy-Revision für eine Umgebung bereitstellen. Nachdem Sie eine Richtlinie angefügt oder Änderungen an einer vorhandenen Richtlinie vorgenommen haben, verwenden Sie die Apigee-UI oder die Apigee API, um die Änderungen bereitzustellen.

Erzwingung von Richtlinien prüfen

Um zu prüfen, ob eine Richtlinie ordnungsgemäß erzwungen wird, muss die API von einem HTTP-Client aufgerufen werden. Um eine Quota-Konfiguration zu prüfen, legen Sie ein Kontingent fest (z. B. eine Anfrage pro Minute) und senden Sie dann mehrere Anfragen an die API, um das in der Kontingentrichtlinie festgelegte Kontingentlimit zu überschreiten. (Der URI-Pfad, der im ProxyEndpoint als Basispfadeinstellung konfiguriert ist, lautet in der folgenden Anfrage /weather).

http://ORG_NAME-test.apigee.net/weather/forecastrss?w=12797282

Wenn Sie mehr als eine Anfrage innerhalb einer Minute gesendet haben, sollten Sie die folgende Fehlermeldung sehen:

{
   "fault":{
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

Daran erkennen Sie, dass die Richtlinie Quota von Apigee erzwungen wird.

Richtlinienbasierte Fehlerbehandlung

Beachten Sie das Format der oben aufgeführten Fehlermeldung. Es enthält die Attribute faultstring und errorcode. In vielen Fällen müssen Sie ein Verhalten implementieren, das mit diesen Fehlern umgehen kann. Sie können beispielsweise eine benutzerdefinierte Nachricht an einen Entwickler ausgeben, dessen Anwendung die Quota überschreitet.

Weitere Informationen zur Fehlerbehandlung finden Sie unter Fehlerbehandlung.

Best Practices: Allgemeine Richtliniensätze

Zur Einhaltung der grundlegenden Verwaltungsanforderungen erzwingen API-Proxys normalerweise die folgenden Richtlinien:

Grundlegende API-Schlüsselvalidierung

ProxyEndpoint-Anforderungs-Flow:

SpikeArrest
XMLThreatProtection oder JSONThreatProtection
API-Schlüsselüberprüfung
Quota
ResponseCache

ProxyEndpoint-Antwort-Flow:

ResponseCache

Grundtransformation: JSON in XML

Anfrage-Flow:

SpikeArrest
JSONThreatProtection
API-Schlüsselüberprüfung
Quota
JSONToXML

Antwort-Flow:

XMLToJSON
ResponseCache