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

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

ただいまの
回答率

89.72%

受け取ったAPIリクエストの対象データが存在しない場合は、どんなレスポンスを返すべき?

解決済

回答 2

投稿 編集

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

murabito

score 28

受け取ったAPIリクエストの対象データが存在しない場合は、どんなレスポンスを返すべきか?

 Case1

GET    /comments


この場合、空の配列をステータスコード200で返してあげるので良いですよね?

 Case2

GET    /comment

この場合は返すべきレスポンスはステータスコード200でnullでしょうか?

 Case3

GET    /comments/99999


99999に対応するデータが存在しない場合、ステータスコード404でnullを返すべきでしょうか?
もしくはステータスコード404でnullすら返さない?

 Case4

GET    /comments?userId=99999


この場合はステータスコード200で空の配列を返すで良いでしょうか?
クエリパラメーターの99999にマッチするものがなくても、リソースが存在していないとも異なるので、
404ということでもないのかなと思いました。

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 2

checkベストアンサー

+4

単一レコードを取得するAPIであれば、レコードがなかったら404を返すべきで、
正常終了である200を返すのは良くないと考えています。
配列を返すAPIならば、200でも問題ないですけど。
レコードが見つからない=エラーではないため。

GET /comments => レコードがあろうがなかろうが配列を返せばいいので、200
GET /comments?userId=99999 => 配列で返すので200
GET /comment => どのレコードを返せば良いか不明というかパラメータが不足している。Bad Requestという事で400
GET /comment/1 => レコードがなければ404、あれば200

もちろん、想定するレスポンスとしては、

GET /comments => [ {"id": 1, "user_id": 1, ..}, {"id": 2, "user_id": 100, ...}, ..., ]
GET /comment/1 => { "id": 1, "user_id": 1, ...}
という形ですよね?

自分がAPIを作る場合は、GET /comment/1で404などのエラーの場合は、
こんな感じでより具体的なエラー内容を返すようにしています。

{
  "error": {
    "code": 1000,
    "message": "record not found: id=1"
  }
}

特にフロント側でエラーを表示する時は、エラーコードを元に判定する事が多いです。
APIのレスポンスに含まれるエラーメッセージは、ログなどに出力して開発者側にとって分かりやすいようにしてます。
デバッグ情報的な扱いです。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

+3

RESTFullな考えならば常に複数形を使えとあるので単数形の場合の制御は不要でそのようなリソースは無いとし404で良いでしょう

存在しない場合は404で良いですが、存在するエンドポイントに対するものならResponseは気の利いたものが良いでしょう

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

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

  • ただいまの回答率 89.72%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる
  • トップ
  • Javaに関する質問
  • 受け取ったAPIリクエストの対象データが存在しない場合は、どんなレスポンスを返すべき?