APIのレスポンスにおいて、ステータスコードだけでは不親切？

Question

APIでクライアントがデータを送信した時に値に不備があったとします。
その時、400か500のエラーが想定されますが、400や500のステータスコードを返すだけでは不親切でしょうか？
この値が足りない、文字数がオーバーしているなどの文字も一緒に返したほうが良いのでしょうか。

また、Railsの場合どのように記述すれば実現できますか？
よろしくお願いいたします。

Answer 1

単純にリソースがないとか、サーバーエラーだとかの情報を返すのであれば、ステータスコードだけで大丈夫だと思いますが、
パラメータの書式が違うとか、細かな部分を表現するために、内部のエラーコードとエラーメッセージをJSONか何かで返すのが一般的じゃないでしょうか。
とはいえ、APIのエラーメッセージ使用はサービス毎にまちまちなので、親切さと実装のしやすさでうまい事バランスを取って決めるしかなさそうです。

ここの記事は結構参考になります。
WebAPIでエラーをどう表現すべき？15のサービスを調査してみた

Answer 2

rifuchさんが言うようにステータスコードだけでは足りないケースが有るので、ステータスコード403+JSONでエラーコードとメッセージを送るというようなやり方が多いと思います。
私は基本、ステータスコード200以外は全てクライアント側でJSONのエラーコードを見て処理を判断してもらうようにしてます。