WebAPIの設計、リクエストパラメータの選び方

Question

やりたい事

フロント(js)とバックエンド(php)のデータのやり取りを扱うAPIに関しての質問です。
良くあるもっと見るボタンを作っています。表示するものは以下のコンテナと言う順序をもつデータです。
もっと見るボタンを押す度にphpにデータを問い合わせて表示します。

CREATE TABLE container (
  `id` int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
  `type` int(10) UNSIGNED NOT NULL,
  `order_index` int(10) UNSIGNED NOT NULL,
  `content` text NOT NULL
) ENGINE = InnoDB DEFAULT CHARACTER SET = utf8mb4

質問

処理の流れとしては
0. ボタンを押すとAPIでサーバーにデータを問い合わせる
0. レスポンスで上記デーブルのコンテナともっとデータがあるかを判断する為のboolean next　を返す
0. フロントでレスポンスを受けてデータを表示してnext がfalse ならもっと見るボタンを非表示にする。

この場合APIのリクエストパラメータを以下の様IDのリストにするのはDBを覗かれている様で嫌なのですがなぜダメなのか上手く言語化できません。バックエンドの処理としてはテーブルのプライマリキーであるIDを渡されるとDBのレコードを取ってくる処理がとても書きやすいのですがこれはありですか？

{
   "id":[
      1,
      2,
      3,
      4,
      5
   ]
}

試した事

プライマリキー以外だと type と order_index で実質データを絞り込めるので以下の様な
startのorder_indexの値からsize分のレコードを取得すると言うリクエストパラメータで処理を書いてみました。php のコードは今回重点ではないので省きます。

{
   "type":1,
   "start":5,
   "size":5
}

クエリが以下の形ですね。

SELECT `content`, `order_index` 
FROM `container` 
WHERE `type` = :type AND `order_index >= :start AND `order_index` <= :start+size;

質問2

フロント側のHTML, JSにデータを持たせてコンテナの追加、削除、更新、順序交換などの処理を追加で実装するとした場合
結局、全てのコンテナにtype, order_index の情報を持たせる必要があるならばID１つで済むならその方が楽ではないでしょうか？

API設計に悩む時間が多く作り直しを何度かしているのでご教示いただけたら幸いです。

Answer 1

質問１について

バックエンドの処理としてはテーブルのプライマリキーであるIDを渡されるとDBのレコードを取ってくる処理がとても書きやすいのですがこれはありですか？

もっと見るの前にIDのリストを取得して保持しておくという事ですよね。
一覧のデータ量が多い場合はクライアント、及び、サーバーサイドでメモリを圧迫する可能性があるため、データ量によってはNGです。
ただパフォーマンス的にはIDリストを渡した方が良いと思われます。

ページングのパラメーターとして最小で必要と思われるのは[開始ID or Indexなど]だけです。
（取得件数はサーバーサイドで固定されていたら必要ないですが通常パラメーター指定するかと思います。）

それ以上の情報を含める場合はそれ相応の理由があればOKかと思います。

質問２について

フロント側のHTML, JSにデータを持たせてコンテナの追加、削除、更新、順序交換などの処理を追加で実装するとした場合
結局、全てのコンテナにtype, order_index の情報を持たせる必要があるならばID１つで済むならその方が楽ではないでしょうか？

IDだけで管理したいという事であればそれができればそのように設計する方が良いです。
やり取りする情報も保持しておく情報も必要最小限の物とすべきです。

Comments

[mipopon]

なるほど保持、通信するデータを最小限に留めるにはIDの受け渡しですね。
どのデータを受け渡してもセキュリティー的に問題は無いし後はデータ量と実装しやすさの問題と言う事ですね。

Answer 2

https://gist.github.com/gushernobindsme/45f848f3dba1b29a91c226b6298bcd1f#%E5%A0%85%E7%89%A2%E3%81%AA-web-api-%E3%82%92%E4%BD%9C%E3%82%8B

自分でも色々調べた結果わかった事のまとめ。

• 内部APIの場合はそんなに気を使わなくても良い。ブラウザからアクセス出来る場合はセキュリティーに気を使おう。
• 上部リンクで見つけた対策すべきはXSS,XSRF,JSONハイジャック。　入出力時のデータをチェックしよう。

要は開発スピードを出せてセキュアでフロント側に優しい実装を目指そう。