REST API を利用する

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

REST API を有効にする

顧客モデルの準備

ここではチュートリアルで説明した「顧客」モデルを例に、REST API を有効にしてみます。

ドラッグ&ドロップで顧客モデルを作成する

REST APIの設定

モデルごとに、REST API を有効にするかどうかを指定することができます。標準では無効（REST APIは利用しない）となっています。

ロック方式を変更する

REST API を利用するモデルで更新と削除を行う場合は、楽観ロック方式としてください。（悲観ロックには対応していません。）

更新と削除を行わない場合は、悲観ロックのままでも問題ありません。（ロック処理が行われないため）
REST API を有効にする

REST API が必要な設定

いくつかの機能は、REST API を有効にする必要があります。詳細は各機能のマニュアルで説明されています。マニュアルの指示に従い、本設定を有効にしてください。

モデルIDを変更する

標準では「"MODEL" + 数字」となっています。ここでは "CUSTOMER" とします。

モデルIDを変更する

モデルIDを変更する理由

通常、開発者および利用者のいずれもモデルIDを意識することはありません。しかし REST API を利用する場合、呼び出し側 (Wagbyの外部) はモデルIDを指定します。（日本語のモデル名は使いません。）そのため MODEL1 や MODEL2 では使いづらいため、CUSTOMER など識別しやすい ID へ変更することをおすすめします。

モデルIDの変更は最初に行う

一つでもスクリプトを設定すると、モデルIDは変更できなくなります。そのためモデル作成のタイミングでモデルIDを変更するとよいでしょう。

命名規則

モデルIDの命名規則は次のとおりです。

  • モデルIDは2文字以上、30文字以内としてください。
  • 先頭は "A" から "Z" の文字を利用できます。
  • 2文字目以降は "A" から "Z" および "0" から "9" の数字を含めることができます。
  • 記号（アンダースコアなど）、英小文字、スペースを含めることはできません。
  • いくつかの文字列は Wagby 内部で予約されています。利用できない文字列であれば警告が出力されますので、別の名前に変えてください。

項目IDを変更する

標準では「"ITEM" + 数字」となっています。ここでは次のようにします。

項目名 変更前の項目ID 変更後の項目ID
ID id id (変更なし)
顧客名称 ITEM1 NAME
顧客カナ ITEM2 KANANAME
会社名称 ITEM3 COMPANYNAME
会社住所 ITEM4 COMPANYADDRESS
会社創業日 ITEM5 FOUNDED
業種 ITEM6 INDUSTRY
備考 ITEM7 MEMO
項目IDを変更する

命名規則

項目IDの命名規則は次のとおりです。

  • 項目IDは2文字以上、30文字以内としてください。
  • 先頭は "A" から "Z" の文字を利用できます。
  • 2文字目以降は "A" から "Z" および "0" から "9" の数字を含めることができます。
  • 記号（アンダースコアなど）、英小文字、スペースを含めることはできません。
  • いくつかの文字列は Wagby 内部で予約されています。利用できない文字列であれば警告が出力されますので、別の名前に変えてください。

CORSの設定

CORS(Cross-Origin Resource Sharing)とは、WebブラウザがHTMLを読み込んだ以外のサーバからデータを取得する仕組みです。

CORSのイメージ

WagbyのREST APIを「Webブラウザから」呼び出す場合、そのWebブラウザを許可する必要があります。

※ Webブラウザではないアプリケーション（例 スマートフォンのネイティブアプリケーション）がWagbyのREST APIを呼び出す場合は CORS の設定は不要です。

Swagger Editorを利用する

次ページより、WagbyのREST APIを試すために Swagger Editor を使います。 そのため、ここで CORS の設定を行っておきます。

「環境 > アプリケーション > CORS」の欄に、次の値をセットしてください。 

http://localhost:8080
CORSの設定

この設定により、開発者のPCで（ローカルで）起動した Swagger Editor からクラウド上の Wagby アプリケーションの REST API を呼び出すことができます。

curlを利用する

curlを使って Wagby アプリケーションの REST API を呼び出すことができます。

この場合は CORS の設定は不要です。