2021-11-15 Web API のエラー表現
Web API のエラー表現
WebAPIでエラーをどう表現すべき?15のサービスを調査してみた - Qiita
トップレベルにエラーオブジェクト
{
// error info
}
error というキーを用意する
{
"error": {
// error info
}
}
複数エラーを用意する場合
error”s” と複数形にしてそこでArrayで詰める感じ?
{
"errors": [
{
// error1
},
{
// error2
},
]
}
こう思ったっす
内部的には1つのエラーオブジェクトとして表現して、それを単数のエラー情報として返してあげるのが良さそうだと思った(内部で複数エラーが発生してもユーザーから観るとそれは一つのエラーに見えるので)。