REST API 仕様

最終更新日: 2022年9月20日

API一覧

次の REST API が標準で提供されます。

ログオン/ログオフAPI

メソッド API 説明
GET /rest/session ログオンユーザの情報を取得する。
POST /rest/session ログオン。
DELETE /rest/session ログオフ。

モデルごとに用意されるAPI

メソッド API 説明
GET /v3/モデルID 一覧表示データを取得する。
POST /v3/モデルID 新規追加を行う。
GET /v3/モデルID/{ID} 主キーを指定して1件のデータを取得する。
PUT /v3/モデルID/{ID} 主キーを指定して1件のデータを更新する。
DELETE /v3/モデルID/{ID} 主キーを指定して1件のデータを削除する。
GET /v3/モデルID/_ 新規登録用のデータを取得する。Wagbyのスクリプト「登録(初期データ作成)」が実行されたもの。

次ページより、APIの使い方の詳細を説明します。

REST API を使う

開発者は次の手順で REST API を使うことができます。

Swagger Editor を使う

  1. 外部から REST API で操作したいモデルについて、REST API を有効にします。（標準は無効です。）
  2. 開発者の PC で Swagger Editor を起動します。本マニュアルでは Docker を使って Swagger Editor を起動する方法を説明します。
  3. Swagger Editor からクラウドにある Wagby 開発環境に接続し、ビルドしたアプリケーションを操作できることを確認します。
  4. Wagby の REST API を呼び出すアプリケーションを開発します。

本マニュアルでは上記の 1 から 3 を説明します。3までを試したあと、必要なアプリケーションの開発を行ってください。

curl を使う

上記の 1 を行ったあと、すぐに curl を使って動作を確認することができます。

複合キーモデルの場合

複合キーモデルの場合、次のようになります。 

/(リソース名)/(複合主キー1)/(複合主キー2)/...

例を示します。CUSTOMERモデルのキーがPKEY1とPKEY2という複合キーモデルを想定します。PKEY1の値が "1000" で、PEKY2の値が "2022-10-01" のデータを取得する場合は次のようになります。 

GET /CUSTOMER/1000/2022-10-01

パスに指定する値は、複合キーの並び順（キー1, キー2,...）となります。記述する順番に意味があります。

その他の注意事項

  • 画面を作成しない設定とは無関係です。例えばあるモデルの新規登録画面を作成しない、と設定した場合でも新規追加の REST API は有効です。
  • 上と関連しますが、特定の REST API（例えば新規追加）を無効にすることはできません。
  • 選択肢モデル（初期データ固定）は「一覧表示取得」「主キーを指定して1件のデータを取得する」のみ利用できます。登録や更新、削除の REST API はエラー (404) になります。