ActionList - ぺったんR Wiki - ぺったんR

一覧取得API @ AboutController

リクエスト

method	get
urlパラメータ	{page,page_size}
POSTデータ	json形式*
html	○
json	○

*オープンモードのとき、誰でも可 →RunMode

解説

アイテムをリストで返す。

HTMLページでは、ファイラーを使って一覧表示する。

urlパラメータ

page

何ページ目から表示するかを数値で指定する。省略したときは1である。

• http://localhost:3000/scrolls?page=2

page_size

1ページに収まるデータ数を数値で指定する。省略したときは25である。指定可能な最大値は100である。それ以上の値を指定しても最大値に切り詰められる。

• http://localhost:3000/resource_pictures?page_size=100

POSTデータ

auth_token

• 外部からjsonで要求する場合、認証処置として認証トークンが必要。

戻り値

json系

正常ケース

• ステータスコード200 OKとともに、json構造のデータを返す。

例外ケース

• ユーザアカウントまたは管理者アカウントでサインインしてなかった。(Devise)
  • ステータスコード401 Unauthorizedを返すとともに、応答メッセージにUnauthorizedを返す。
  • ただし、オープンモードで起動しているなら、サインインの必要はない。

html系

正常ケース

• ステータスコード200 OKとともに、テンプレートから起こしたページを返す。

例外ケース

• ユーザアカウントまたは管理者アカウントでサインインしてなかった。(Devise)
  • ステータスコード302 Foundを返すとともに、サインインを促すページ(/users/sign_in)へ遷移する。
  • ただし、オープンモードで起動しているなら、サインインの必要はない。