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

phing

今までphpunit,phpmd,phpcodesniffer,phpdocumentなどのツールをいろいろと試してきますが、個別に動かしていると大変面倒ですので、これを一気に行えるライブラリがありま …

no image

テスト環境のデータ作りに関して

単体テスト以降の環境ですとテストのデータを作ることがなかなか大変だと思います。マスタなどはそのままもらうこともあると思いますので、主にトランザクションデータについて。 以前もこのネタに関しては色々書い …

no image

ログインしたままにするの挙動に関して(ステートフル認証の基本的な仕組みの復習もかねて)

基礎の基礎ですが、ログイン処理に関しての動きに関して。 Contents1 通常のログイン処理に関して2 ログインしたままにする 通常のログイン処理に関して 通常のログイン処理では、まず以下のような手 …

no image

1度に1つのことを

今回のリーダブルコードの概念はやや抽象的。 要は一度に行うタスクは1つにする、というところがポイントになります。 そのための手法として下記のようなことを上げています。 コードが行っているタスクをすべて …

no image

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

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

アーカイブ