RESTコンポーネントのフィールド定義にウェブAPIからのレスポンスを取り込む

RESTコンポーネントhttp_rest.pngには、専用のダイアログを使ってテスト実行をする機能があるのをご存じでしょうか?

以前、この機能を使ってウェブAPIの動作を確認する方法を紹介しました。

前回の記事ではウェブAPIを実行して動作を確認するところまででしたが、ウェブAPI実行時に返されるレスポンスの値を使用して後続のコンポーネントで処理を行いたい場合には、RESTコンポーネントの出力ストリームのフィールドの定義を行う必要があります。

出力ストリームのフィールド定義にはいくつかのストリーム型が指定できますが、ウェブAPIを実行する場合は、大抵レスポンスの形式がXMLかJSONなので、ストリーム型はXML型にすることをお勧めします。

通常、XML型のフィールド定義を編集するには次の3つの方法が用意されています。

  • フィールドを一行ずつ編集
  • CSV形式でまとめて編集
  • あらかじめ定義しておいたXMLファイルをインポート
RESTコンポーネントを使用する場合には、これに加えてもう一つ便利な方法が用意されているので、今回はその方法を紹介したいと思います。

まずはウェブAPIをテスト実行します。
ウェブAPIをテスト実行する手順については前回の記事を参照していただくとして、実行結果は次のようになります。
rest_result.png


実は、RESTコンポーネントの便利な機能として、実行結果のレスポンスをそのままフィールド定義として取り込むことができるんです。
やり方は簡単で、画面下の「XMLフィールド定義のインポート」ボタンをクリックするだけです。

どうでしょう?ストリームペインを見るとフィールド定義が取り込まれていますね。
xml_field_definition.png

今回実行したウェブAPIのレスポンスはJSON形式だったのですが、その場合は自動的にXMLに変換した上でフィールド定義に反映してくれます。

この方法を使えば、ちょっと面倒なXML型のフィールド定義も簡単にできてしまうので、ぜひ使ってみてください。
それでは。

この記事は役に立ちましたか?
3人中2人がこの記事が役に立ったと言っています

他のキーワードで検索する