Swagger Editor で REST API を試す (2)

API一覧

「REST API 仕様」をお読みください。

前ページで認証処理を行っているため、次節より各APIの使い方を説明します。

一覧

右側の API 一覧から GETメソッド /v3/モデルID を開きます。

"Try it out" ボタンをクリックします。

このAPIは「取得開始位置」「取得終了位置」「並び順 (ASC/DESC)」「ソート項目」を指定することができます。ここではデフォルト値のままとし、"Execute" ボタンをクリックします。

"Server response" に "Code 200" が表示されればデータの取得は成功です。正常終了の場合、ステータスコード200となります。

"Response body" に取得した一覧の JSON データが10件表示されます。

パラメータを指定する

取得終了位置を "5" とし、並び順を "ASC" (昇順) から "DESC" (降順) に変更してみます。"Execute" ボタンをクリックします。

降順で5件のデータが返されます。

新規登録

右側の API 一覧から POSTメソッド /v3/モデルID を開きます。

"Try it out" ボタンをクリックします。

"Request body" に送信したいデータを JSON 形式で記述できる欄が用意されます。

"Request body" に次の登録データを入力して "Execute" ボタンをクリックします。

{
  "NAME": "ジャスミン太郎",
  "COMPANYNAME": "ジャスミンソフト",
  "INDUSTRY": "ソフトウェア業"
}

このCUSTOMERモデルは主キー(ID)は順序値による自動採番方式となっていました。新規登録が成功すると自動的にIDがセットされていることがわかります。

取得(1件)

右側の API 一覧から GETメソッド /v3/モデルID/{ID} を開きます。

"Try it out" ボタンをクリックします。

ID 入力欄に先ほど登録したデータの主キー1010を入力し、"Execute" ボタンをクリックします。

"Server response" に "Code 200" が表示されればデータの取得は成功です。

wbversion

次の操作でデータの更新を行います。ここで取得された JSON データに含まれる "wbversion" の数値をメモしておいてください。更新時に必要となります。（この図の例では "0" となっています。)

wbversionは楽観ロックを制御するための値です。取得時に得られた値を更新時に送信します。他に誰もこのデータを更新していないかどうかを、wbversion の値を使って（Wagbyが内部で）確認します。

更新

右側の API 一覧から PUT メソッド /v3/CUSTOMER/{ID} を開きます。

"Try it out" ボタンをクリックします。

"Request body" に送信したいデータを JSON 形式で記述できる欄が用意されます。

ID 入力欄に取得したデータの主キー 1010 を入力し、"Request body" に次のデータを入力します。"Execute" ボタンをクリックします。

{
  "id": 1010,
  "NAME": "ジャスミン太郎",
  "KANANAME": "ジャスミンタロウ",
  "COMPANYNAME": "ジャスミンソフト",
  "COMPANYADDRESS": "沖縄県宜野湾市宇地泊902-1",
  "FOUNDED": "2001-03-14",
  "INDUSTRY": "ソフトウェア業",
  "NOTE": "ジャスミンソフトは、ノーコード・ローコード開発プラットフォームの国内ベンダーです。",
  "wbversion": 0
}