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 エラーの情報伝達に関して2 ログの見方3 デプロイ4 タスクコミュニケーション(タスク管理ツール) 主にスト …

no image

抽象性と可読性のトレードオフに関して

私自身プログラムを書く場合、とにかくコードを書く量を制限したいという思いが強く、多少でも共通化できる箇所がある場合はなるべく共通化するようにしておりましたが、時と場合によっては過剰に共通化したことによ …

no image

バッチスクリプトで気をつけたい点

実務でバッチ処理を作る際に気をつけるべきと思ったこと。 基本的にエラーをいかに捉えていかにログに吐くかを最初に考える。まずはエラーありき。失敗するもの、想定した値がこない、あるいは値がないを前提として …

no image

Oauthについて

今更ながら認証システムの基本などを復習中です。 今回はOauth(オーオース)について。 一般的なWebサービスを使っていると Instagramでのアカウントがある場合、それのアカウントを利用して、 …

アーカイブ