Web APIのエラー設計について

Question

既存のWebサービスと連携するWeb APIを設計しています。
下記のURLをもとにしてエラーハンドリングの設計をしているのですが、
どれだけの種類を実装すればいいのか悩んでいます。

参考）
https://liginc.co.jp/web/programming/164003

既存Webサービスでは、DBへのSQL処理など、Webアプリでよく使われている処理を実装しています。

私自身はこれまで、Webアプリケーションの開発で下記のエラー処理を実装したことがあり、設計の検討を行っています。
404 Not Found
403 Forbidden
500 Internal Server Error

この他に実装したほうがいいと思われるエラーハンドリングはどのようなものがあるのでしょうか。

なお、今回設計しているAPIは一般公開するものではなく、システムの連携用に設計しているものです。

Answer 1

200, (301, 302,) 400, 401, 403, 404, 500 くらいは使うことになるんじゃないかな、と思います。
細かい解説はWikipediaなりを参考にしてください。
https://ja.wikipedia.org/wiki/HTTP%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9%E3%82%B3%E3%83%BC%E3%83%89
API実装を作るなら他にも201なども頭の片隅に置いておくといいですね。

なお、例えば 400 Bad Request を返したとしてもこれだけではクライアント側で何が間違ったのかわかりにくいので、できれば丁寧にエラーメッセージを添えてあげるのが良いと思います。
こちらの記事なども参考になると思います。
https://qiita.com/suin/items/f7ac4de914e9f3f35884

Comments

[退会済みユーザー]

ご返事が遅くなりました。
ありがとうございます！
必要と思われるものを一つ一つ調査していこうと思います。