skillup

技術ブログ

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

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

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

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

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

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

200

一般的なリクエスト成功

201

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

400(422)

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

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

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

401

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

403

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

404

NotFound。リソースがない。

500

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

 

参考

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

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

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

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

執筆者:


comment

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

関連記事

no image

例外処理に関して

いまいち使い方がいい加減だった例外処理について、復習がてらメモします。 昔のリンクを整理して出てきた例外リンクはこちら(Javaですが今のPHPにも当てはまるかと思います。) 例外処理について 例外処 …

no image

命名規則について その2

リーダブルコードネタ第3段。 前回のエントリーに引き続き、名称の大切さについて Contents1 あいまいな名前はNG!1.1 限界値はmaxかminを使う1.2 範囲を指定するときはfirstとl …

no image

単体テスト仕様書について

おそらく開発者が書きたくないものの筆頭になるかと思う単体テスト仕様書ですが、うまく使うと有益なコミニケーションツールになります。 Contents1 ユーザーのフロー体験・説明書2 前提となるデータ3 …

no image

コード静的解析ツールを使った際の気づきなど

最近のプロジェクトでコード静的解析ツール(phpcs,phpmd)を使った際の気づきなど コードを書きながら常時エディタがチェックするタイプのものでないとまず無理(保存するたびでも無理だし、コミット時 …

no image

JavaScriptライブラリ sugar

去年、JavaScriptの仕事をがりがりやった時にお世話になったライブラリsugar。 JavaScriptのライブラリというとunderscore.jsが有名ですが、こいつも結構使えるライブラリで …

アーカイブ