Nur DataPower-API-Gateway

Extrahieren

Verwenden Sie die Richtlinie Extrahieren , um Daten aus Feldern im API-Kontext zu extrahieren und umzusetzen.

Vorbereitende Schritte

Tabelle 1. Gateways, die diese Richtlinie und die entsprechenden Richtlinienversionen unterstützen
Gateway Richtlinienversion
DataPower® API Gateway 2.0.0
Draft comment: slaflamm@us.ibm.com
Need to verify available versions.

In diesem Abschnitt wird die Konfiguration der Richtlinie im Assembly-Editor beschrieben. Weitere Informationen zur Konfiguration der Richtlinie in Ihrer „ OpenAPI “-Quelle finden Sie unter „extract “.

Informationen zu dieser Task

Die Richtlinie Extrahieren gibt die Datenquelle an, die den zu transformierenden Inhalt enthält, die Felder, die den Inhalt enthalten, und Ausdrücke, die definieren, wie der Inhalt transformiert wird. Sie verwenden eine Untergruppe der JSONata-Notation zur Angabe der Felder, die extrahiert und transformiert werden sollen. Weitere Informationen finden Sie unter „Erstellen von JSONata-Ausdrücken zum Extrahieren und Transformieren von Daten “.

Die Eingabe für die Richtlinie Extrahieren muss syntaktisch analysiert werden. Eine Möglichkeit, geparste Daten zu erzeugen, besteht darin, eine Parsing -Richtlinie vor der Richtlinie Extrahieren in Ihrer Assembly hinzuzufügen.

Vorgehensweise

  1. Klicken Sie im Navigationsbereich auf Symbol 'Entwickeln' im Navigationsfenster „Entwickeln “ und wählen Sie dann die Registerkarte „APIs“ aus.
    Die Seite Entwickeln wird angezeigt.
  2. Klicken Sie auf den Titel der API-Definition, mit der Sie arbeiten möchten.
  3. Wählen Sie die Registerkarte Gateway aus und klicken Sie dann im Navigationsfenster auf Richtlinien .
    Weitere Informationen zur Arbeit mit dem Assembly-Editor für eine API finden Sie unter „Der Assembly-Editor “.
  4. Suchen Sie die Richtlinie Extrahieren in der Palette und ziehen Sie die Richtlinie in Ihren Erstellungsbereich.
  5. Geben Sie die folgenden Eigenschaften an.
    Tabelle 2. Eigenschaften der Richtlinie extrahieren
    Eigenschaftsbezeichnung Erforderlich Beschreibung Datentyp
    Titel Ja Der Titel der Richtlinie.

    Der Standardwert ist extract.

    Zeichenfolge
    Beschreibung Nein Eine Beschreibung der Richtlinie. Zeichenfolge
    Stammverzeichnis Ja Die Datenquelle, die den zu transformierenden Inhalt enthält.

    Der Standardwert ist message.body.

    Zeichenfolge
    Erfassen Ja Der Pfadausdruck, der das Feld angibt.

    Die Standardeinstellung ist $und gibt die gesamte Eingabe an.

    Zeichenfolge
    Transformieren Ja Der Ausdruck, der definiert, wie der Inhalt umgewandelt werden soll Zeichenfolge
  6. Legen Sie eine Version für die Richtlinie fest, indem Sie auf das Symbol „Quelle“ klicken und den entsprechenden version Abschnitt Symbol für OpenAPI -Quelle der YAML-Datei der Richtlinie ausfüllen. Beispiel:
    execute:
      - extract:
          version: 2.0.0
          title: extract
    ...
    Sie müssen eine Version für die Richtlinie angeben, die mit dem Gateway kompatibel ist, das Sie verwenden. Wenn die API veröffentlicht wird und die Version nicht mit dem Gateway kompatibel ist, wird ein Gültigkeitsfehler ausgelöst, der die verfügbaren Versionen angibt.
  7. Klicken Sie auf Speichern.

Beispiel

Setzen Sie den Inhalt des Felds account so um, dass er nur die letzten 4 Zeichen enthält.
- extract:
    version: 2.0.0
    title: extract
    root: message.body
    extracts:
      - capture: $.members.policy.**.account
        transform: $substring($,-4)
    description: Include only the last 4 characters of the account field.