AboutController - ぺったんR Wiki - ぺったんR

コントローラ @ AboutManifest

コントローラーに定義されているアクションを判別するための情報。例えば、アクションタイプが「詳細」の時、 APIのレスポンスは一件のデータを返す。カウントの時は、数値を返す。この判別がつかないと、クライアントは応答値を適切に処理できない。

基本的にはCRUD+リストの形となる。アクションはいくつかのタイプに分けられており、用意されていないタイプのアクションに対応することはできない。

アクションタイプ

リスト

一覧データを返すためのアクション。

ActionList

カウント

リストの全体の件数を返すためのアクション。必ずしも正確な数値では無い。

ActionCount

詳細

パラメータのIDで指定したアイテムを返すためのアクション。

ActionShow

プレイリスト

パラメータのIDで指定したアイテムを返すためのアクション。

ActionPlay

新規作成

アイテムを新規に作成するためのアクション。

ActionNew

編集

パラメータのIDで指定したアイテムを編集するためのアクション。

ActionEdit

命名規則

基本的にはrailsの命名規則に従うが、一覧関係でいくつかの命名規則を追加した。

• index, show, new, edit

カウント

indexリストトの全体の件数を返すためのアクションの命名はcountとする。例えばスクロール一覧の総数を返すAPIは次のようになる。

http://localhost:3000/scrolls/count.json

フィルタ一覧

あるアイテムに所属するアイテムの一覧を取得するときに使うための絞り込みリスト。親モデルのIDを指定することで、条件を入力できる。その場合の命名規則はby_xxxxのようになる。例えば、スクロールパネルをスクロールID:1でフィルタしたリストを取得するためのAPIは次のようになる。

http://localhost:3000/scroll_panels/by_scroll/1

フィルタカウント

フィルタ一覧をページ制御するときに必要な、全体の総数を取得する。先程のフィルタ一覧の命名規則の例を継承すると、APIの命名規則は次のようになる。

http://localhost:3000/scroll_panels/count_by_scroll/1.json

所持アイテム一覧

自身が所持するアイテムの一覧を取得する時のリスト。その場合の命名規則は/home/itemsのようになる。例えば、自身が作成したコマのリストを取得するためのAPIは次のようになる。

http://localhost:3000/home/panels

所持アイテムカウント

所持アイテム一覧をページ制御するときに必要な、全体の総数を取得する。先程の所持アイテム一覧の命名規則の例を継承すると、APIの命名規則は次のようになる。

http://localhost:3000/home/panels.json