ステータスコード
ステータスコードは、HTTPのレスポンスにおいてサーバ側の処理結果を示すために定義されているコードで、レスポンスの一部としてクライアントに返却されます。クライアントではステータスコードをもとに、適切なエラーハンドリングなどを実装することができます。
1. 2xx(成功)
2から始まるステータスコードは、正常な状態を示す番号体系です。
1.1 200 OK
リクエストが正常に処理されたことを表すステータスコードです。最も基本的な成功レスポンスで、GETリクエストでデータの取得に成功した場合や、PUTリクエストでデータの更新に成功した場合などに返されます。
HTTP/1.1 200 OK
Content-Type: application/json
{"id": 1, "name": "田中太郎", "email": "tanaka@example.com"}
この例では、ユーザ情報の取得リクエストに対して200 OKが返され、ボディにユーザのデータが含まれています。
1.2 201 Created
リソースの作成が正常に完了したことを示すステータスコードです。POSTメソッドによって新しいデータが作成された場合に返されます。
HTTP/1.1 201 Created
Content-Type: application/json
{"id": 2, "name": "鈴木花子", "email": "hanako@example.com"}
この例では、新しいユーザの作成リクエストに対して201 Createdが返され、ボディに作成されたユーザのデータ(自動採番されたIDを含む)が含まれています。
2. 4xx(クライアントエラー)
4から始まるステータスコードは、クライアント側に原因があるエラーを示します。
2.1 400 Bad Request
クライアントからのリクエストが不正である場合に返されるステータスコードです。リクエストの形式が正しくない場合や、必須のパラメータが不足している場合などが該当します。
HTTP/1.1 400 Bad Request
Content-Type: application/json
{"error": "name is required"}
この例では、必須パラメータであるnameが含まれていないリクエストに対して400 Bad Requestが返され、ボディに不足しているパラメータの情報が含まれています。
2.2 403 Forbidden
リソースへのアクセスが禁止されている場合に返されるステータスコードです。認証の成否に関わらず、権限がないユーザがリソースにアクセスを試みたときに返されます。
HTTP/1.1 403 Forbidden
Content-Type: application/json
{"error": "You do not have permission to access this resource"}
この例では、権限のないリソースへのアクセスに対して403 Forbiddenが返され、ボディにアクセスが拒否された理由が含まれています。
2.3 404 Not Found
指定されたリソースがサーバ上に存在しない場合に返されるステータスコードです。多くの場合、URLのパスが誤っていることが原因です。
HTTP/1.1 404 Not Found
Content-Type: application/json
{"error": "User not found"}
この例では、存在しないユーザへのリクエストに対して404 Not Foundが返され、ボディにリソースが見つからなかった旨が含まれています。
3. 5xx(サーバエラー)
5から始まるステータスコードは、サーバ側に原因があるエラーを示します。
3.1 500 Internal Server Error
サーバ内部で予期しないエラーが発生した場合に返されるステータスコードです。サーバの設定ミスやアプリケーションのバグなどが主な原因です。
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
{"error": "Internal Server Error"}
この例では、サーバ内部でエラーが発生し、500 Internal Server Errorが返されています。クライアント側では原因を特定できないため、サーバ側のログを確認する必要があります。
3.2 503 Service Unavailable
サーバが一時的に利用できない場合に返されるステータスコードです。サーバのメンテナンスや過負荷、バックエンドサービスの停止などが該当します。
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
{"error": "Service temporarily unavailable"}
この例では、サーバが一時的に利用できない状態であることを示す503 Service Unavailableが返されています。通常、時間をおいて再度リクエストを送ることで解決します。
| 📝 ステータスコードの活用 |
|---|
| ステータスコードを適切に使用することで、クライアントとサーバが共通の認識を持ち、処理結果を効果的に伝えることが可能になります。これにより、システムが期待どおりに動作しているか、またはどの部分で問題が発生しているかを確認することに繋がります。 |
ステータスコードの一覧をまとめると以下のとおりです。
| ステータスコード | 分類 | 説明 |
|---|---|---|
200 OK |
成功 | リクエストが正常に処理された |
201 Created |
成功 | 新しいリソースの作成が完了した |
400 Bad Request |
クライアントエラー | リクエストの形式が不正、または必須パラメータが不足している |
403 Forbidden |
クライアントエラー | リソースへのアクセス権限がない |
404 Not Found |
クライアントエラー | 指定されたリソースが存在しない |
500 Internal Server Error |
サーバエラー | サーバ内部で予期しないエラーが発生した |
503 Service Unavailable |
サーバエラー | サーバが一時的に利用できない |