API Management-RichtlinienbeispieleAPI Management policy samples

Richtlinien sind eine leistungsfähige Funktion des Systems, mit der Herausgeber das Verhalten der API über eine Konfiguration ändern können.Policies are a powerful capability of the system that allows the publisher to change the behavior of the API through configuration. Richtlinien sind eine Sammlung von Anweisungen, die sequenziell bei Anfragen oder Antworten einer API ausgeführt werden.Policies are a collection of statements that are executed sequentially on the request or response of an API. Die folgende Tabelle enthält Links zu Beispielen und liefert eine kurze Beschreibung für jedes Beispiel.The following table includes links to samples and gives a brief description of each sample.

Eingehende RichtlinienInbound policies
Hinzufügen eines Forwarded-Headers, um der Back-End-API das Erstellen geeigneter URLs zu ermöglichenAdd a Forwarded header to allow the backend API to construct proper URLs Veranschaulicht, wie Sie einen Forwarded-Header in die eingehende Anforderung einfügen, damit die Back-End-API die richtigen URLs erstellen kann.Demonstrates how to add a Forwarded header in the inbound request to allow the backend API to construct proper URLs.
Hinzufügen eines Headers mit eine Korrelations-IDAdd a header containing a correlation id Veranschaulicht, wie Sie der eingehenden Anforderung einen Header mit einer Korrelations-ID hinzufügen.Demonstrates how to add a header containing a correlation ID to the inbound request.
Hinzufügen von Funktionen zu einem Back-End-Dienst und Zwischenspeichern der AntwortAdd capabilities to a backend service and cache the response Veranschaulicht das Hinzufügen von Funktionen zu einem Back-End-Dienst.Shows how to add capabilities to a backend service. Beispielsweise können Sie in einer API zur Wettervorhersage anstelle von Längen- und Breitengrad einen Ortsnamen akzeptieren.For example, accept a name of the place instead of latitude and longitude in a weather forecast API.
Autorisieren des Zugriffs basierend auf JWT-AnsprüchenAuthorize access based on JWT claims Veranschaulicht, wie Sie den Zugriff auf bestimmte HTTP-Methoden in einer API basierend auf JWT-Ansprüchen autorisieren.Shows how to authorize access to specific HTTP methods on an API based on JWT claims.
Autorisieren von Anforderungen mit einem externen AutorisiererAuthorize requests using external authorizer Veranschaulicht, wie Sie einen externen Autorisierer zum Sichern des API-Zugriffs verwenden.Shows how to use external authorizer for securing API access.
Autorisieren des Zugriffs mithilfe von Google-OAuth-TokenAuthorize access using Google OAuth token Veranschaulicht, wie Sie den Zugriff auf Ihre Endpunkte mithilfe von Google als OAuth-Tokenanbieter autorisieren.Shows how to authorize access to your endpoints using Google as an OAuth token provider.
Generieren von Shared Access Signatures und Weiterleiten von Anforderungen an Azure StorageGenerate Shared Access Signature and forward request to Azure storage Veranschaulicht, wie Sie Shared Access Signatures mithilfe von Ausdrücken generieren und die Anforderung mithilfe der rewrite-uri-Richtlinie an Azure Storage weiterleiten.Shows how to generate Shared Access Signature using expressions and forward the request to Azure storage with rewrite-uri policy.
Abrufen von OAuth2-Zugriffstoken aus AAD und Weiterleiten des Tokens an das Back-EndGet OAuth2 access token from AAD and forward it to the backend Stellt ein Beispiel zur Verwendung von OAuth2 für die Autorisierung zwischen dem Gateway und einem Back-End bereit.Provides and example of using OAuth2 for authorization between the gateway and a backend. Dieses zeigt, wie Sie ein Zugriffstoken aus AAD abrufen und an das Back-End weiterleiten.It shows how to obtain an access token from AAD and forward it to the backend.
Abrufen von X-CSRF-Token aus einem SAP-Gateway mit einer Richtlinie zum Senden einer AnforderungGet X-CSRF token from SAP gateway using send request policy Veranschaulicht, wie Sie das von vielen APIs verwendete X-CSRF-Muster implementieren.Shows how to implement X-CSRF pattern used by many APIs. Dieses Beispiel bezieht sich speziell auf das SAP-Gateway.This example is specific to SAP Gateway.
Weiterleiten der Anforderung basierend auf der Größe des TextkörpersRoute the request based on the size of its body Veranschaulicht, wie Sie Anforderungen basierend auf der Größe des Textkörpers weiterleiten.Demonstrates how to route requests based on the size of their bodies.
Senden von Anforderungskontextinformationen an den Back-End-DienstSend request context information to the backend service Veranschaulicht, wie Kontextinformationen zum Zweck der Protokollierung oder Verarbeitung an den Back-End-Dienst gesendet werden.Shows how to send some context information to the backend service for logging or processing.
Festlegen der Aufbewahrungsdauer von Antworten im CacheSet response cache duration Veranschaulicht, wie Sie die Aufbewahrungsdauer von Antworten im Cache mit dem maxAge-Wert in dem vom Back-End gesendeten Cache-Control-Header festlegen.Demonstrates how to set response cache duration using maxAge value in Cache-Control header sent by the backend.
Ausgehende RichtlinienOutbound policies
Filtern des AntwortinhaltsFilter response content Veranschaulicht, wie Sie Datenelemente aus der Antwortnutzlast basierend auf dem der Anforderung zugeordneten Produkt filtern.Demonstrates how to filter data elements from the response payload based on the product associated with the request.
Richtlinien bei FehlerOn-error policies
Fehler in Stackify protokollierenLog errors to Stackify Veranschaulicht, wie Sie eine Richtlinie für die Protokollierung von Fehlern hinzufügen, um diese Fehler für die Protokollierung an Stackify zu senden.Shows how to add an error logging policy to send errors to Stackify for logging.