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

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

新規登録して質問してみよう
ただいま回答率
85.50%
Ruby

Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

Node.js

Node.jsとはGoogleのV8 JavaScriptエンジンを使用しているサーバーサイドのイベント駆動型プログラムです。

Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

PHP

PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

Q&A

解決済

2回答

4112閲覧

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

murabito

総合スコア108

Ruby

Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

Node.js

Node.jsとはGoogleのV8 JavaScriptエンジンを使用しているサーバーサイドのイベント駆動型プログラムです。

Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

PHP

PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

1グッド

1クリップ

投稿2018/08/15 03:39

編集2018/08/15 05:29

受け取った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ということでもないのかなと思いました。

A-pZ👍を押しています

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

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

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

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答2

0

ベストアンサー

単一レコードを取得する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などのエラーの場合は、
こんな感じでより具体的なエラー内容を返すようにしています。

json

1{ 2 "error": { 3 "code": 1000, 4 "message": "record not found: id=1" 5 } 6}

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

投稿2018/08/15 04:23

mingos

総合スコア4025

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

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

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

投稿2018/08/15 04:36

namda

総合スコア705

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問