質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.59%

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

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 201

mipopon

score 38

やりたい事

フロント(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

質問

処理の流れとしては

  1. ボタンを押すとAPIでサーバーにデータを問い合わせる
  2. レスポンスで上記デーブルのコンテナともっとデータがあるかを判断する為のboolean next を返す
  3. フロントでレスポンスを受けてデータを表示して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 の情報を持たせる必要があるならばID1つで済むならその方が楽ではないでしょうか?

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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+1

質問1について

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

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

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

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

質問2について

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2020/02/29 17:51

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

    キャンセル

0

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ハイジャック。 入出力時のデータをチェックしよう。 

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.59%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る