skillup

技術ブログ

ドキュメント作成 プログラミング全般

APIのエラーコードに関して

投稿日:2021年9月5日 更新日:

APIのよく使われるHTTPステータスコードに関して。

基礎の基礎で当たり前に使ってましたが、基本的なことに関してまとめ。

主に4XXエラーのタイプ分けに関して。

200

一般的なリクエスト成功

201

リソースが作成された場合の成功(200で代用することもあるかと思います。)

400(422)

リクエスト不正。バリデーションなどリクエストパラメータ不正の場合などが一般的。

400:リクエスト自体が無効

422:一般的なバリデーションエラー

401

認証エラー。主にBasic認証などAPIに到達までにNGになるパターン。

403

リクエストによる操作権限がない(許可されていない)ときにつかわれる。
認証(401)と認可(403)の違いに注意!

認証・・そもそもユーザーとしてログインできないなど、ユーザー自体の確認などに使われる

認可・・特定動作の権限があるかないかのケースで使われる

404

NotFound。リソースがない。

500

システムエラーが発生している場合。(例外エラー系)

 

参考

422 Unprocessable Entity(422エラー)が表示される原因を解説

https://qiita.com/NagaokaKenichi/items/eb85b5fbb719d60c6627

代表的なHTTPステータスコードと問題解決へのヒント

-ドキュメント作成, プログラミング全般
-,

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

コードレビュー時のポイント

コードレビュー(仕様的な点ではなくて規約的なところのチェック)などで気をつけることなど。 ポイントとしては検知ツールで確認するコストを減らすことが一番大事(カスタマイズの方法について調べておく)、ある …

no image

気をつけたいトリガー系の処理など

実務でひやっとすることがあり、自分への戒めも込めてメモします。 Contents1 MySQLのcurrent_timestamp on update current_timestamp2 Larav …

no image

サロゲートキーと主キーに関して

今までも何度か触れたサロゲートキーと主キーに関して。 今までの参考リンク 論理設計のグレーノウハウ サロゲートキー サロゲートキーに関して 主にシステム設計的な考察が多かったので、今回はユースケースか …

no image

障害報告などでの伝える情報の視点

障害の重要度(後続タスクにブロックがあるかいなか)、調査原因(仕様不理解、設計考慮もれ、ケアレスミス)、影響度(画面単位などで) 障害が起こっているデータ(あるいはスクショなどで伝えられるか) 再現プ …

no image

データのシリアライズ

おととしにJavaをやったときにでてきましたがSessionに情報を格納するときにでてきたシリアライズについて。 セッションはステートフルな状態を実現するための便利なデータの保存方法ですが、値をオブジ …

アーカイブ