前回の記事でRest APIを作成するためのトランザクションの設定と、APIの実行時のリクエストヘッダの設定までを投稿しました。
後編ではAPIでデータの登録、取得、更新、削除を実行するための方法と実行結果について記載します。
データの登録
リクエスト
アドレス
|
1 |
http://ホスト名:ポート番号/アプリ名/rest/トランザクション名/0 |
今回Java（Tomcatをデプロイ先）で作成していますが、”Servlet”やモジュール名はアドレスに含まれません。
また、”rest”は固定のアドレスになります。
メソッド
|
1 |
POST |
ボディ
|
1 |
{"SampleRestName":"aaaa"} |
レスポンス
ステータスコード
|
1 |
201 |
レスポンスデータ
|
1 |
{"SampleRestId":1,"SampleRestName":"aaaa","gx_md5_hash":"025103d3816045e8bc09b0b0355c8402"} |
主キーの項目属性の Autonumer プロパティを”True”にしているため、自動的に割り当てられた値がレスポンスに含まれています。
また、レスポンスデータの最後に、ハッシュ値があるのがわかります。
データの取得
リクエスト
アドレス
|
1 |
http://ホスト名:ポート番号/アプリ名/rest/トランザクション名/1 |
アドレスの最後の数値は取得したい主キーの値です。
メソッド
|
1 |
GET |
ボディ
なし。
レスポンス
ステータスコード
|
1 |
200 |
レスポンスデータ
|
1 |
{"SampleRestId":1,"SampleRestName":"aaaa","gx_md5_hash":"025103d3816045e8bc09b0b0355c8402"} |
データの更新
リクエスト
アドレス
|
1 |
http://ホスト名:ポート番号/アプリ名/rest/トランザクション名/1 |
メソッド
|
1 |
PUT |
ボディ
|
1 |
{"SampleRestId":1,"SampleRestName":"bbbb","gx_md5_hash":"025103d3816045e8bc09b0b0355c8402"} |
パラメータの中にも主キーの項目が必要なのと、更新にはハッシュ値が必要になります。
リクエストの送信前にはハッシュ値がわからないため、ハッシュ値を取得後にデータ更新するという処理の流れになるかと思います。
レスポンス
ステータスコード
|
1 |
200 |
レスポンスデータ
|
1 |
{"SampleRestId":1,"SampleRestName":"bbbb","gx_md5_hash":"568ca39d3daeaf3df87dcdc4506b5df6"} |
データの削除
リクエスト
アドレス
|
1 |
http://ホスト名:ポート番号/アプリ名/rest/トランザクション名/1 |
メソッド
|
1 |
DELETE |
ボディ
なし。
レスポンス
ステータスコード
|
1 |
204 |
レスポンスデータ
なし。
まとめ
Business Componentを使用すると、RestfulなRest APIが作成することができます。
1テーブルに対するシンプルなデータの取得や更新には、有用かと思います。
