最近見たAPIのエラーメッセージ↓
{apiId: "xxx", errorCode: "00001",errorMessage: "xxxxx error."}
これでは情報量が少な過ぎる。
一応このAPIではエラーコードからエラーの詳細を確認できるエラーコード定義表が提供されていたのだが、それとて精々「○○の項目が不足しています」程度の情報量しかなく、それならエラーメッセージにその旨書いてあれば十分だったのでは？？ というお気持ちが生じた。
この事例から考えるに、別途エラー定義表を提供するぐらいならばAPIのエラーレスポンス自体に十分な情報を持たせた方がAPI開発者・API利用者共に無駄な調査や開発が減ることが予想できる。
したがって、APIのエラーレスポンスとエラーメッセージは極力リッチな情報を持たせるべきであるとの結論に至った。