GeneXusでAPIを作成

「GeneXusでAPIはどうすれば作れますか？」との質問をいただいたので、本日は簡単なAPIを作ってみようと思います。

コンテンツ一覧

今回は商品テーブルを参照し、商品データを返すAPIを作ろうと思います。

まず商品テーブルを下記のような感じで作ります。

合わせてSDTも作成します。

トランザクションが出来たら、後ほどAPIで取得するデータを登録しておきます。

では早速APIを作ってきましょう。
まずAPIはプロシージャで作成します。

プロシージャのRulesは下記のように記載。

パラメータとして商品IDを受け取って、商品の情報をSDTに格納して返します。

Sourceは下記のような感じ。

商品IDが渡ってこなかったら全件返すようにします。

プログラムの記述は以上で終了。

ただこれだとただのプロシージャなので、プロパティを変更します。

プロシージャのプロパティにあるExpose as Web ServiceをTrueに変更してください。
Main programはTrueでもFalseでもどちらでもいいです。

これでAPIの作成が完了。

APIが出来たら実際に呼んでみましょう。

今回はPostmanと言うツールから呼びます。

Postmanは下記からダウンロード可能です。
https://www.postman.com/jp/downloads/

Postmanの設定は下記の通り。

まずプロシージャはPOSTで呼びます。

またURIに関してはアプリを実際に動かすときのURLと同様なのですが、プロシージャ名の前に「rest/」と付けてあげてください。
プロシージャ名は実際に定義している名前と同じにしてください。
（大文字小文字も合わせる）
またパッケージ名は不要です。

ボディにパラメータを書きます。
こちらはRulesで記載した変数名と合わせて書いてください。
（「&」は不要です）
また今回は数値型なので「0」と記載してますが、文字型の場合は「”（ダブルクォーテーション）」で囲ってあげてください。

で、実際に呼んで返ってきた結果が下記となります。

パラメータとして商品IDを渡してないので全件取得してます。

次にパラメータを渡した結果が下記となります。

正常に１商品だけ取得してますね。

プロシージャがプロパティ１つでAPIになるのは便利ですね。

プロパティを変えても普通のプロシージャと同様にWebPanel等からも呼ぶことが可能です。

今回はデータを取得するAPIを作りましたが、データの作成や更新、削除のプロシージャを作ればそれをAPIとして呼ぶことも可能です。

また今回はGAMなどの認証は使っていないので、APIを呼ぶときに認証は入れてませんが、GAMを使っている場合はAPIキーだったり、アクセストークンだったりが必要になってきます。