Skip to main content

 

拡張および連携

 

 

OutSystems

1つまたは複数のREST APIメソッドを利用する

開始する前に、REST APIのドキュメントで必要な情報をすべて収集してください。

Service Studioでは、以下を行うことができます。

  • Swaggerの仕様ファイルに記載されているすべてのREST APIの利用。これらを利用するにはURLを入力するか、ローカルファイルシステムから仕様ファイルを選択します。

  • 単一のREST APIメソッドの利用。

REST APIのすべてのメソッドを利用する

Swaggerの仕様に準拠しているREST APIのすべてのメソッドを利用することができます。OutSystemsが公開しているREST APIは、この仕様に準拠しています。

Swaggerの仕様は、URLを指定するかローカルファイルシステムから仕様ファイルを選択してインポートすることができます。

以下の手順を実行します。

  1. Logic]タブで、Integrationsフォルダを開きます。

  2. REST要素を右クリックし、[Consume REST API...]を選択します。

  3. 表示されたダイアログで、[Add All Methods]を選択します。

REST APIをインポートすると、Service Studioでは以下が実行されます。

  • REST APIの作成
  • 対応する入出力パラメータを持つREST APIメソッドの作成
  • REST APIの名前が付いた新しいツリー要素にある対応する入出力パラメータを保持するストラクチャの作成
  • RESTデータ型とOutSystemsのデータ型のマッピング

REST APIの単一のメソッドを利用する

OutSystemsでは、リクエストやレスポンスのコンテンツ例に基づいてREST APIの単一のメソッドを利用することができます。POSTPUTなどの操作メソッドでは、URLやボディで入力パラメータの指定が必要な場合があります。

以下の手順を実行します。

  1. Logic]タブで、Integrationsフォルダを開きます。

  2. REST要素を右クリックし、[Consume REST API...]を選択します。

  3. 表示されたダイアログで、[Add Single Method]を選択します。

  4. メソッドのURLに関する情報を入力します。中カッコで囲んだパラメータを、メソッドの入力パラメータのURLに含めることができます。

    例:
    GET https://api.example.com/Portal/rest/Contacts/GetAll
    GET https://api.example.com/Portal/rest/...ts/Get?Id={Id}
    POST https://api.example.com/Portal/rest/Contacts/Create

    URL内の中括弧で囲んで定義された各入力パラメータがメソッドの入力パラメータになります。

  5. 利用しているREST APIが特定のヘッダーを必要とする場合やHTTPベーシック認証を使用する場合は、[Headers / Auth]タブを開き、必要な情報を入力します。

  6. リクエストとレスポンスに関する情報を入力します。APIに対するテストを実行してテスト結果を使用すると非常に簡単です。

    Body]タブの[Request]フィールドと[Response]フィールドに、JSONストラクチャまたはプレーンテキストの例を直接追加することもできます。[Test]タブを開きます。メソッドのURLにパラメータがある場合は、テストを実行するためにパラメータ値を挿入する必要があります。

    POSTPUTなどの操作メソッドについては、Body ContentのRequestに対応するリクエストストラクチャを入力してください。

  7. Test]をクリックします。テストに成功すると、[Test]タブの[Response]領域にメソッドのレスポンスが表示されます。

    Response]領域の[Copy to Response body]をクリックし、その情報を[Body]タブの[Response]に入力します。必要なフィールドだけを残します。

    POSTPUTなどの)操作メソッドについては、[Request]領域で[COPY TO RESPONSE BODY]を押してRequestと同様の手順を実行します。

    通常、一般的なフィールドはこの方法で取得できます。使用可能なフィールドすべての詳細については、APIのドキュメントをご覧ください。

  8. Body]タブでリクエストレスポンスの情報が正しいかどうか確認し、[OK]をクリックします。

REST APIメソッドをインポートすると、Service Studioで以下が実行されます。

  • ツリーのREST要素へのREST API要素の作成
  • 対応する入出力パラメータを持つREST APIメソッドの作成
  • REST APIの名前が付いた新しいツリー要素にある対応する入出力パラメータを保持するストラクチャの作成
  • RESTデータ型とOutSystemsのデータ型のマッピング

アプリケーションでREST APIメソッドを使用する

OutSystemsは、Service Studioで作成したアクションと同じセマンティクスを使用して、REST APIによって公開されているメソッドをOutSystemsのアクションに変換します。

これで、アプリケーションで新しく作成されたメソッドを、他のサーバーアクションと同様に使用できるようになりました。

  1. REST APIメソッドを使用するアクションフローに移動します。

  2. Logic]タブで、Integrationsフォルダと:REST要素を開きます。

  3. REST API要素を展開し、REST APIメソッドをアクションフローにドラッグします。

  4. 他のアクションの場合と同様に、メソッドの出力パラメータを使用します。

  • Was this article helpful?