Integrierte Richtlinien

Integrierte Richtlinien werden im Kontext einer API konfiguriert. Mit dem Assembly-Editor API Designer können Sie einer API eine integrierte Richtlinie hinzufügen und die Eigenschaften für diese Richtlinie konfigurieren.

Sie können auch integrierte Richtlinien zu einer API durch Erstellen einer OpenAPI -Definitionsdatei hinzufügen. Weitere Informationen finden Sie unter „Erstellen einer „ OpenAPI “-Definitionsdatei “.

In der folgenden Tabelle ist die Liste der verfügbaren integrierten Richtlinien aufgeführt. Die Tabelle enthält Links zu Konfigurationsinformationen für die integrierten Richtliniendefinitionen und die OpenAPI -Richtliniendefinitionen. Die Richtlinien sind dieselben, sie werden jedoch auf unterschiedliche Arten erstellt.

Tabelle 1. Voreingestellte Richtlinien

Tabelle der integrierten Richtlinien

Integrierte Richtlinie	OpenAPI -Richtlinie	Beschreibung
Aktivitätenprotokoll	activity-log	Verwenden Sie die Richtlinie „Aktivitätsprotokoll“, um Ihre Protokollierungseinstellungen für die API-Aktivitäten zu konfigurieren, die in „ IBM API Connect Analytics“ gespeichert werden. Die Vorgaben, die Sie angeben, setzen die Standardeinstellungen zum Erfassen und Speichern von Details der API-Aktivität außer Kraft. Hinweis: Die Aktivitätenprotokollrichtlinie wird in der Assembly für eine API mit dem Gateway-Typ DataPower API Gatewaynicht unterstützt. Konfigurieren Sie stattdessen die Aktivitätsprotokollierung in den API-Gestaltungseinstellungen. Weitere Informationen finden Sie unter „Konfigurieren der Aktivitätsprotokollierung“ ( OpenAPI2.0 ) oder unter „Konfigurieren der Aktivitätsprotokollierung“ ( OpenAPI3.0 ).		Diese Funktion ist im API-Design vorgesehen; siehe „Konfigurieren der Aktivitätsprotokollierung“ ( OpenAPI2.0 ) oder „Konfigurieren der Aktivitätsprotokollierung“ ( OpenAPI3.0 )
Clientsicherheit	Clientsicherheit	Bietet eine Reihe von Optionen zum Authentifizieren des Clientzugriffs auf Ihre APIs und erweitert die Funktionalität der OpenAPI-Spezifikation.
Extrahieren	extrahieren	Verwenden Sie die Auszug Richtlinie, um Daten aus Feldern Ihrer API zu extrahieren und zu transformieren.
GatewayScript	gatewayscript	Verwenden Sie die Richtlinie gatewayscript , um ein angegebenes DataPower GatewayScript -Programm auszuführen. Die „ GatewayScript “-Richtlinie ist nur mit dem Premium subscription. verfügbar.
JWT generieren	jwt-generate	Verwenden Sie die Sicherheitsrichtlinie Generate JWT in IBM API Connect , um ein JSON Web Token (JWT) zu generieren.
GraphQL-Kostenanalyse	graphql-kostenanalyse	Verwenden Sie die Richtlinie „ GraphQL -Kostenanalyse“, um eine Kostenanalyse einer Zielabfrage zu erhalten.
GraphQL Ausführen	graphql-execute	Verwenden Sie die Richtlinie „ GraphQL Execute“, um eine Abfrage von „ GraphQL “ mithilfe von Unterabfragen auszuführen.
GraphQL-Introspektion	graphql-introspect	Verwenden Sie die „ GraphQL “-Introspect -Richtlinie, um ein „ GraphQL “-Schema zu analysieren.
IF	IF	Verwenden Sie die if-Richtlinie, um einen Abschnitt der Assembly anzuwenden, wenn eine Bedingung erfüllt ist.		Vom Switch bereitgestellte Funktionen
Aufrufen	aufrufen	Wenden Sie die Richtlinie Aufrufen an, um einen anderen Service aus Ihrer Assembly aufzurufen. Die Antwort des Back-Ends wird entweder in der Variable message.body oder in der Antwortobjektvariablen gespeichert, falls diese definiert ist. Die Richtlinie kann mit JSON- oder XML-Daten verwendet werden und kann mehrmals in Ihrer Assembly angewendet werden.
JSON in XML	json-to-xml	Verwenden Sie die Richtlinie JSON in XML , um die Kontextnutzdaten Ihrer API aus dem Format JavaScript Object Notation (JSON) in das XML-Format (Extensible Markup Language) zu konvertieren.
Lambda	Lambda	Verwenden Sie die Lambda-Richtlinie, um „ AWS Lambda “-Funktionen direkt über die API auszulösen, ohne den Amazon- API Gateway zu nutzen.
Zuordnung	Karte	Verwenden Sie die Richtlinie Zuordnen , um Transformationen auf Ihren Assembly-Ablauf anzuwenden und Beziehungen zwischen Variablen anzugeben.
Nachrichtenvorlage	Nachrichtenvorlage	Verwenden Sie die Richtlinie „Message Template“, um eine simulierte API-Antwort für die DataPower API Gateway. zu erstellen.
OAuth	Oauth	Verwenden Sie die OAuth Richtlinie, um die Verarbeitung „ OAuth “ basierend auf den definierten Einstellungen des Anbieters „ OAuth “ durchzuführen.
operation-switch	operation-switch	Verwenden Sie die operation-switch-Richtlinie, um einen Abschnitt der Assembly auf eine bestimmte Operation anzuwenden.
Parsing	parsen	Mit der Richtlinie Parsing können Sie das Parsing eines Eingabedokuments steuern. Wenn es sich bei dem Eingabedokument um eine JSON-Zeichenfolge handelt, wird ein Parsing für die Zeichenfolge ausgeführt, statt sie zu kopieren.
Proxy	Proxy	Wenden Sie die Richtlinie Proxy an, um eine weitere API in Ihrer Assembly aufzurufen, insbesondere wenn die separate API große Nutzdaten enthält. Die Antwort des Back-Ends wird in message.body und in der Antwortobjektvariablen gespeichert, falls diese definiert ist. Pro eindeutigem Assembly-Ablauf darf nur eine Richtlinie ausgeführt werden.		Von Invoke bereitgestellte Funktionen
Ratenbegrenzung	Drosselung	Verwenden Sie die Richtlinie Ratenbegrenzung , um mindestens eine Raten-oder Burstbegrenzung an einem beliebigen Punkt in Ihrem API-Assembly-Ablauf anzuwenden. Raten- und Burstbegrenzungen beschränken die Anzahl der Aufrufe, die eine Anwendung an eine API in einem angegebenen Zeitraum richten kann.
Informationen zur Ratenbegrenzung	ratelimitinfo	Verwenden Sie die Richtlinie „Rate Limit Info“, um Informationen zu Ihren Ratenbeschränkungen abzurufen.
Neubearbeitung Redaktion – DataPower API Gateway Redaktion – DataPower Gateway (kompatibel mit v5 )	redact - DataPower API Gateway redact – DataPower Gateway (kompatibel mit v5 )	Verwenden Sie die Richtlinie Neubearbeitung , um angegebene Felder vollständig aus dem Anforderungshauptteil, dem Antworthauptteil und den Aktivitätenprotokollen zu entfernen oder neu zu bearbeiten. Diese Richtlinie kann nützlich sein, um sensible Daten (z. B. Kreditkartendaten) aus rechtlichen, sicherheitstechnischen oder anderen Gründen zu entfernen oder zu blockieren.
Variable festlegen	set-variable	Mit der Richtlinie Variable festlegen können Sie den Wert einer Laufzeitvariablen festlegen, eine Laufzeitvariable löschen oder eine Headervariable hinzufügen.
Telefonsystem	Telefonsystem	Verwenden Sie die switch-Richtlinie, um einen Abschnitt aus einer Reihe von Abschnitten der Assembly auszuführen, je nachdem, welche angegebene Bedingung erfüllt ist.
auslösen	auslösen	Verwenden Sie die throw-Richtlinie, um einen Fehler auszulösen, wenn die Richtlinie während der Ausführung eines Assembly-Ablaufs erreicht wird.
Benutzersicherheit	user-security	Verwenden Sie die user-security -Richtlinie, um die Berechtigungsnachweise eines Benutzers zu extrahieren, diese Berechtigungsnachweise zu authentifizieren und die Berechtigung vom Benutzer anzufordern.
Validieren Validieren – DataPower API Gateway Validieren – DataPower Gateway (kompatibel mit v5 )	validieren - DataPower API Gateway validieren – DataPower Gateway (kompatibel mit v5 )	Verwenden Sie die Richtlinie Validate , um die Nutzdaten in einem Assembly-Ablauf anhand eines JSON-oder XML-Schemas zu validieren.
JWT validieren	jwt-validate	Verwenden Sie die Sicherheitsrichtlinie JWT validieren , um die Validierung eines JWT (JSON Web Token) in einer Anforderung zu aktivieren, bevor Sie den Zugriff auf die APIs zulassen.
Benutzernamenstoken validieren	Validate-usernametoken	Verwenden Sie die Richtlinie Benutzernamenstoken validieren , um ein Web Services Security (WS-Security) UsernameToken in SOAP-Nutzdaten zu validieren, bevor Sie den Zugriff auf die geschützte Ressource zulassen.
XML in JSON	xml-to-json	Verwenden Sie die XML in JSON -Richtlinie, um die Kontextnutzdaten Ihrer API aus dem XML-Format (Extensible Markup Language) in JavaScript Object Notation (JSON) zu konvertieren.
XSLT	xslt	Verwenden Sie die XSLT-Richtlinie, um eine XSLT-Transformation auf die Nutzdaten der API-Definition anzuwenden. Die XSLT-Richtlinie ist nur mit der Premium subscription.