SpeechesIndex - ぺったんR Wiki - ぺったんR

index @ SpeechesController

セリフ一覧

url

• http://localhost:3000/speeches
• http://localhost:3000/speeches.json

リクエスト

認証	読者*
権限
method	get
urlパラメータ	{page,page_size}
POSTデータ	json形式*
html	○
json	○
jsonp	×

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

解説

セリフの情報を得るための機能。非公開にされたコマで使われたセリフは含まない。APIのために用意した機能なので画面表示はありません。

• セッションまたは認証トークンからユーザアカウントを特定する。
• セリフモデルにページ位置補正を依頼して開始ページを取得する。
  • urlパラメータpageを渡す。
• セリフモデルにページ数補正を依頼して1ページの件数を取得する。
  • urlパラメータpage_sizeを渡す。
• セリフモデルに一覧取得を問い合わせ、その結果をセリフリストとして取得する。
  • ページ位置と件数を渡す。
• 取得したデータを返す。

urlパラメータ

page

• 表示するデータが何ページ目からのものか。

page_size

• 1ページに収まる行の数。

POSTデータ

auth_token

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

戻り値

正常系

• htmlのとき、ステータスコード200 OKとともに、テンプレートから起こしたページを返す。
• jsonのとき、ステータスコード200 OKとともに、json構造のデータを返す。
  • 出力フォーマットはセリフモデルのjson一覧出力オプションに従う

参考:SpeechesIndexView

例外系

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