intra-mart Accel Platform IM-LogicDesigner チュートリアルガイド 第7版 2018-04-01

4.14. Swagger(SPEC)から実行する

次に、Swaggerを利用して作成したフロールーティングを呼び出し、ロジックフローを実行します。

4.14.1. Swaggerとは

Swaggerとは、RESTful APIに対するドキュメントの標準仕様であり、ドキュメントフォーマッター、および、ビューワーを提供するOSSです。
IM-LogicDesignerでは、作成したフロールーティングの仕様情報をSwaggerに対応した形式で出力します。

コラム

Swaggerについて

Swaggerについての詳細は、以下のリンクを参照してください。

4.14.2. Swaggerを開く

ロジックフロールーティング一覧画面では、ルーティング定義をもとに、Swagger上で対象のルーティングを実行するためのページへのリンクを提供します。
  1. 「サイトマップ」- 「LogicDesigner」-「ルーティング定義一覧」から、ロジックフロールーティング定義一覧を開きます。

  2. 一覧の中から、本チュートリアルで作成したルーティング「tutorial/flow」の行のSPECアイコンをクリックします。

    ../../../_images/swagger1.png

    図:SPECアイコン

  3. Swaggerの提供するREST APIビューワーの画面が新しいウィンドウで表示されます。

    ../../../_images/swagger2.png

    図:Swagger REST APIビューワー

4.14.3. Swaggerからロジックフローを実行する

表示されたSwaggerの画面より、フロールーティングによって利用可能となったREST APIを介して、作成したロジックフローを実行します。
  1. 画面右下のModel Schemaのテキストフィールドをクリックします。

    ../../../_images/execute12.png

    図:Model Schemaフィールド

  2. 自動で、このREST APIを実行するために必要なparameterBodyのテンプレートが挿入されます。

    ../../../_images/execute22.png

    図:parameterBodyへの反映

  3. 挿入されたテンプレートの以下の項目を編集します。

    • message「"Hello! IM-LogicDesigner"
    ../../../_images/execute32.png

    図:Valueの編集

  4. 画面左下の「Try it out!」をクリックします。

    ../../../_images/execute42.png

    図:「Try it out」のクリック

  5. 実行結果が表示されます。

    ../../../_images/execute52.png

    図:実行結果

以上で、Swaggerを利用したフロールーティングの呼び出し、および、ロジックフローを実行が完了しました。
次章「結果を確認する」では、本章で実行したロジックフローの実行結果を確認します。