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

前回の記事でRest APIを作成するためのトランザクションの設定と、APIの実行時のリクエストヘッダの設定までを投稿しました。
後編ではAPIでデータの登録、取得、更新、削除を実行するための方法と実行結果について記載します。

データの登録

リクエスト

アドレス

今回Java(Tomcatをデプロイ先)で作成していますが、”Servlet”やモジュール名はアドレスに含まれません。
また、”rest”は固定のアドレスになります。

メソッド

ボディ

レスポンス

ステータスコード

レスポンスデータ

主キーの項目属性の Autonumer プロパティを”True”にしているため、自動的に割り当てられた値がレスポンスに含まれています。
また、レスポンスデータの最後に、ハッシュ値があるのがわかります。

データの取得

リクエスト

アドレス

アドレスの最後の数値は取得したい主キーの値です。

メソッド

ボディ

なし。

レスポンス

ステータスコード

レスポンスデータ

 

データの更新

リクエスト

アドレス

メソッド

ボディ

パラメータの中にも主キーの項目が必要なのと、更新にはハッシュ値が必要になります。
リクエストの送信前にはハッシュ値がわからないため、ハッシュ値を取得後にデータ更新するという処理の流れになるかと思います。

レスポンス

ステータスコード

レスポンスデータ

 

データの削除

リクエスト

アドレス

メソッド

ボディ

なし。

レスポンス

ステータスコード

レスポンスデータ

なし。

 

まとめ

Business Componentを使用すると、RestfulなRest APIが作成することができます。
1テーブルに対するシンプルなデータの取得や更新には、有用かと思います。

 

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


コメントを残す

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