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

制御フローについて

リーダブルコード 7章。制御フロー(if文などの条件分岐)について ここらへんは個人個人癖がついているとおもいますが、確かに読みやすい、読みにくいというのはあるのでなるべく汎用性のある規則を身につけた …

no image

リーダブルコードまとめ

リーダブルコードほぼ読み切ったのでまとめを。チェックリスト化して、常にこれを見ながらコードは書いたほうがよさげ 前半のまとめや参考リンクでみたものとマージします。 Contents1 変数の名称2 コ …

no image

アクセストークンの分類について

認可情報を取得する際に、ID &パスワードではなく、アクセストークンで認証を行うサービスは多いと思うのですが、アクセストークンにも色々ありますので、再度まとめておこうと思います。 以前まとめた …

no image

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

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

no image

Encypter、Decrypeterについて

独自の鍵を使ってencrypt,decrptメソッドを実装したので、メモを。 Contents1 参考ソース2 encrypt,decrptの内部について3 base64エンコーディングについて 参考 …

アーカイブ