extract

extract ポリシーを使用して、API コンテキストのフィールドからデータを抽出および変換します。

ゲートウェイのサポート

表 1. このポリシーおよび対応するポリシー・バージョンをサポートするゲートウェイ
ゲートウェイ	ポリシーのバージョン
DataPower® API Gateway	2.0.0

このトピックでは、 OpenAPI ソースでのポリシーの構成方法について説明します。アセンブリー・ユーザー・インターフェースでのポリシーの構成方法について詳しくは、抽出を参照してください。

製品情報

extract ポリシーは、変換するコンテンツを含むデータ・ソース、コンテンツを含むフィールド、およびコンテンツの変換方法を定義する式を指定します。 JSONata 表記のサブセットを使用して、抽出および変換するフィールドを指定します。詳しくは、データを抽出および変換するための JSONata 式の構成を参照してください。

extract ポリシーへの入力は、解析済みデータでなければなりません。解析済みデータを生成する 1 つの方法は、アセンブリー内で extract ポリシーの前に parse ポリシーを追加することです。

extract ポリシーの形式は次のとおりです。

- extract:
    version: 2.0.0
    title: title
    root: data source
    extracts:
      - capture: path expression that identifies the field
        transform: expression that defines how to transform the content
                   .
                   .
                   .
    description: description

このポリシーを適用するには、 execute フィールドを持つ assembly 拡張を OpenAPI 定義ファイルに追加します。

プロパティ－

表 2. extract ポリシーのプロパティー
プロパティー・ラベル	必須	説明	データ・タイプ
version	はい	ポリシーのバージョン番号。使用しているゲートウェイと互換性のあるバージョンをポリシーに指定する必要があります。 API の公開時に、バージョンがゲートウェイと非互換の場合、使用可能なバージョンを指定する検証エラーがスローされます。	ストリング
title	はい	ポリシーのタイトル。デフォルト値は `extract`です。	ストリング
description	いいえ	ポリシーの説明。	ストリング
root	はい	変換するコンテンツを含むデータ・ソース。デフォルト値は `message.body`です。	ストリング
capture	はい	フィールドを識別するパス式。デフォルト設定は `$`で、これは入力全体を示します。	ストリング
transform	はい	コンテンツの変換方法を定義する式。	ストリング

例

account フィールドの内容を、最後の 4 文字のみを含むように変換します。

- 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.