DataPower API Gateway のみ

DataPower API GatewayJSON to XML ポリシーの構成

以下のステップに従って、アセンブリー・ユーザー・インターフェースで DataPower® API Gateway「JSON to XML」 ポリシーを構成します。

このタスクについて

注: このトピックでは、 DataPower API Gatewayでの JSON to XML ポリシーの実装について説明します。 を使用している場合は DataPower Gateway (v5 compatible)、 「 DataPower Gateway ( v5 互換)のJSONからXMLへのポリシー設定 」を参照してください。 さまざまなタイプのゲートウェイについて詳しくは、 API Connect ゲートウェイ・タイプを参照してください。

OpenAPI ソースでのポリシーの設定方法については、 json-to-xmlを参照してください。

手順

  1. ナビゲーション ペインで [開発] ナビゲーション・ペインの「開発」アイコン をクリックし、 [API ] タブを選択します
    「開発」 ページが開きます。
  2. 作業対象の API 定義のタイトルをクリックするか、新規 API を作成します。
  3. 「ゲートウェイ」 タブを選択し、ナビゲーション・ペインで 「ポリシー」 をクリックします。
    APIのアセンブリ エディターの操作に関する詳細については、 「アセンブリ エディター」 を参照してください。
  4. パレットで 「JSON to XML」 ポリシーを見つけて、そのポリシーをキャンバスにドラッグします。
  5. 以下のプロパティーを指定します。
    表 1. ポリシーのプロパティ
    プロパティー・ラベル 必須 説明 データ・タイプ
    役職 はい ポリシーのタイトル。

    デフォルト値は json-to-xmlです。

    ストリング
    説明 いいえ ポリシーの説明。 ストリング
    入力 いいえ 変換する入力メッセージ。 API コンテキスト内の変数の名前を指定します。 variableName.body、 メッセージ・ペイロード。変換する JSON 入力を表します。 この変数のデフォルト値は message であり、message.body がデフォルトの入力です。 ストリング
    出力 いいえ 変換結果を保管するための出力メッセージ。 API コンテキストの変数の名前を指定します。 variableName.body が、JSON 形式から XML 形式への変換の結果を表します。 指定された入力メッセージがデフォルトのメッセージである場合、デフォルトの出力は message.body です。 それ以外の場合、例えば、入力メッセージが変数 my-message-variable である場合は、デフォルトの出力は my-message-variable.body となります。

    変数を、API コンテキストの読み取り専用にすることはできません。

    ストリング
    変換のタイプ いいえ 出力のターゲット形式を決定する変換タイプ。 使用可能なオプションは次のとおりです。
    • None: 出力の変換が行われません。
    • badgerFish: BadgerFish 規則は、出力のターゲット変換形式を決めるために使用されます。
    ストリング
    ルート XML エレメント名 はい 結果の XML 文書のルート・エレメント名。 このプロパティーは、入力 JSON 文書が階層ではなく、複数の最上位レベルのプロパティーを持つ場合、または 「常にルート・エレメントを出力する」 チェック・ボックスが選択されている場合にのみ使用されます。

    デフォルト値は jsonです。

    ストリング
    常にルート・エレメントを出力 (Always output the root element) はい XML 文書を整形式にする必要がない場合でも、常にポリシーにルート・エレメントを出力させるには、このチェック・ボックスを選択します。

    デフォルト値は falseです。

    ブール値
    JSON 配列エレメントのエレメント名 いいえ JSON 配列エレメントに使用される XML エレメント名です。 ストリング
  6. [ソース] アイコンをクリックし、ポリシーの YAML ファイルの [ OpenAPI ソース・アイコンversion] セクション version を指定して、ポリシーのバージョンを設定します。 以下に例を示します。
    execute:
      - json-to-xml:
          version: 2.0.0
          title: json-to-xml
      ...
    使用しているゲートウェイと互換性のあるバージョンをポリシーに指定する必要があります。 API の公開時に、バージョンがゲートウェイと非互換の場合、使用可能なバージョンを指定する検証エラーがスローされます。
  7. 「保存」をクリックします。

例えば、以下の単純な JSON オブジェクト
{ "a": { "$" : "hello" } }
この CRN は以下のようになります。
<a>hello</a>
1 つの属性が指定された以下の JSON オブジェクト
{ "a": { "$" : "hello", "@type" : "world" } }
この CRN は以下のようになります。
<a type="world">hello</a>