Business Componentを使用したRest APIの作成(前編)

昨今システム間のI/Fとして利用されつつあるRest  APIが、GeneXusでも作成することができます。
Rest APIが作成できるオブジェクトは以下の3種類です。

  1. トランザクション(Business Component)
  2. プロシージャ
  3. データプロバイダ

今回はトランザクション(Business Component)を使用して作成します。

トランザクションの設定

Rest APIでデータを扱うトランザクションを作成し、以下のプロパティを変更します。

  • Business Component:True
  • Expose as Web Service:True
  • Web Service Protocol:ReST Protocol

トランザクションの設定

今回は項目属性は Autonumber プロパティを”True”にした主キーの項目と、Varchar型の項目属性の2項目を用意しました。
なお、RulesやEventsエレメントには特に定義する必要はありません。

リクエストのヘッダ

今回はGeneXus内部のオブジェクトからAPIを実行するのではなく、外部からリクエストを受けるというシチュエーションを想定します。

任意のHTTPリクエストが送信可能なツール(JMeterやFiddlerなど)を用意します。
JSON形式でデータを送信するため、HTTPヘッダには下記を定義します。

 

記事が長くなりますので、以降は次回に投稿します。

Business Componentを使用したRest APIの作成(後編)

 

システム開発のご相談はこちらからお気軽にお問合せください。


コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です