validate - DataPower Gateway (v5 compatible)

Verwenden Sie die Richtlinie validate , um die Nutzdaten in einem Assembly-Ablauf anhand eines Schemas zu validieren.

Gateway-Unterstützung

Hinweis: Auf dieser Seite wird die validate -Richtlinienimplementierung in DataPower® Gateway (v5 compatible)beschrieben. Wenn Sie das verwenden DataPower API Gateway, lesen Sie bitte die Anleitung unter „validate“ – DataPowerAPI Gateway.

Informationen zu den verschiedenen Gateway-Typen finden Sie unter API Connect Gateway-Typen.

Tabelle 1. Tabelle, aus der hervorgeht, welche Gateways diese Richtlinie unterstützen, sowie die entsprechende Richtlinienversion
Gateway	Richtlinienversion
DataPower Gateway (v5 compatible)	1.0.0

In diesem Thema wird beschrieben, wie Sie die Richtlinie in Ihrer „ OpenAPI “-Quelle konfigurieren. Einzelheiten zur Konfiguration der Richtlinie in der Benutzeroberfläche von „Assembly“ finden Sie unter „Validate – DataPower Gateway “ (kompatibel mit v5 ).

Einschränkung:

Das Schema, das für die XML steht, kann nur auf einen XML-Namensbereich verweisen.
Das Schema kann nicht auf polymorphe XML-Elemente verweisen.
Die Validierung funktioniert nur für die Variable message.body und für keine andere Ausgabe-/Kontextvariable. Wenn die invoke-Richtlinie eine konfigurierte Antwortobjektvariable enthält, wird message.body nicht festgelegt und die Validierung kann nicht durchgeführt werden.
Wenn Sie das Schlüsselwort multipleOf in einer Schemadefinition für die API verwenden, muss der angegebene Wert aufgrund des Rundungsverhaltens die folgenden Bedingungen erfüllen, da andernfalls die Validierung fehlschlägt, wenn die API aufgerufen wird:
- Der Wert darf nicht kleiner als 0.000000999999999999999848869 sein.
- Ist der Wert größer als 1, darf der Betrag vor dem Dezimalzeichen nicht größer als 999999999999999934463 sein.

Produktinfo

Die Richtlinie validate hat das folgende Format:

- validate:
  version: version
  title: title
  description: description
  definition: swagger_schema_definition_to_be_used

Wenden Sie diese Richtlinie an, indem Sie eine Erweiterung assembly mit einem Feld execute zu Ihrer OpenAPI -Definitionsdatei hinzufügen.

Eigenschaften

In der folgenden Tabelle werden die Richtlinieneigenschaften beschrieben:

Tabelle 2. validate Eigenschaften der Richtlinie
Eigenschaft	Erforderlich	Beschreibung	Datentyp
version	Ja	Die Versionsnummer der Richtlinie	Zeichenfolge
title	Nein	Ein Titel für die Richtlinie.	Zeichenfolge
description	Nein	Eine Richtlinienbeschreibung.	Zeichenfolge
definition	Ja	Das für die Validierung der Nutzdaten zu verwendende Schema. Die gültigen Werte sind im Folgenden aufgelistet: `request`: Wählen Sie diesen Wert aus, um die Anforderungseingabe anhand der Schemadefinition zu validieren, die im Feld Typ für den Anforderungsparameter für diese Operation angegeben ist. Informationen zum Erstellen eines Anforderungsparameters finden Sie unter Operation konfigurieren. `response`: Wählen Sie diesen Wert aus, um die an die Clientanwendung zurückzugebende Antwort anhand der Schemadefinition zu validieren, die im Feld Schema für den Antwortparameter für diese Operation angegeben ist. Informationen zum Erstellen eines Antwortparameters finden Sie unter Operation konfigurieren. Der Name der Schemadefinition weist das folgende Format auf: `#/definitions/schema_name` Das Schema muss im Abschnitt `definitions:` Ihrer OpenAPI -Datei definiert sein.	Zeichenfolge

Sie können auch eine validate -Richtlinie anwenden, indem Sie mit dem Assembly-Editor API Designer eine integrierte Richtlinie zur API hinzufügen. Weitere Informationen finden Sie unter „Validate – DataPower Gateway (kompatibel mit v5 ) “ im Abschnitt „Integrierte Richtlinien“.

Beispiel 1

validate:
  version: 1.0.0
  title: validate the response
  definition: #/definitions/RouteOutput