APIサーバーでよく使われるステータスコード
2024-3-14 | API
APIサーバーでよく使われるステータスコードをまとめてみた。（自分のために）
GET編
GETはAPIサーバーではデータ取得に使われる。
| ステータスコード | 意味 | 備考 |
|---|---|---|
| 200 | OK | 成功 |
| 304 | Not Modified | キャッシュ |
| 400 | Bad Request | リクエストエラー |
| 401 | Unauthorized | 認証エラー |
| 401 | Forbidden | 認可エラー |
| 404 | Not Found | データなし |
| 429 | Too Many Requests | アクセス過多（レートリミット制限超過） |
| 500 | Internal Server Error | サーバー障害 |
| 503 | Service Unavailable | 応答不可（高負荷） |
POST編
POSTはAPIサーバーではデータ登録に使われる。
| ステータスコード | 意味 | 備考 |
|---|---|---|
| 200 | OK | 成功。レスポンスボディに処理したデータを含める |
| 201 | Created | レスポンスヘッダーLocationに登録したデータへのURLを含める場合 |
| 202 | Accepted | 非同期処理を受け付けた場合 |
| 304 | Not Modified | キャッシュ |
| 400 | Bad Request | リクエストエラー |
| 401 | Unauthorized | 認証エラー |
| 403 | Forbidden | 認可エラー |
| 409 | Conflict | リクエスト内容の衝突 |
| 429 | Too Many Requests | アクセス過多（レートリミット制限超過） |
| 500 | Internal Server Error | サーバー障害 |
| 503 | Service Unavailable | 応答不可（高負荷） |
PUT編
PUTはAPIサーバーではデータ登録・更新に使われる。
| ステータスコード | 意味 | 備考 |
|---|---|---|
| 200 | OK | 成功。レスポンスボディに処理したデータを含める |
| 201 | Created | レスポンスヘッダーLocationに登録したデータへのURLを含める場合 |
| 202 | Accepted | 非同期処理を受け付けた場合 |
| 204 | No Content | データ更新。データは返さない。 |
| 304 | Not Modified | キャッシュ |
| 400 | Bad Request | リクエストエラー |
| 401 | Unauthorized | 認証エラー |
| 403 | Forbidden | 認可エラー |
| 404 | Not Found | データなし（更新するデータがない場合） |
| 409 | Conflict | リクエスト内容の衝突 |
| 429 | Too Many Requests | アクセス過多（レートリミット制限超過） |
| 500 | Internal Server Error | サーバー障害 |
| 503 | Service Unavailable | 応答不可（高負荷） |
DELETE編
DELETEはAPIサーバーではデータ削除に使われる。
| ステータスコード | 意味 | 備考 |
|---|---|---|
| 200 | OK | 成功。削除の場合はレスポンスボディに処理したデータを含めない。 |
| 202 | Accepted | 非同期処理を受け付けた場合 |
| 204 | No Content | 成功。削除が成功したのでデータが無い。こちらもレスポンスボディに処理したデータを含めない |
| 401 | Unauthorized | 認証エラー |
| 403 | Forbidden | 認可エラー |
| 404 | Not Found | データなし（削除するデータがない場合） |
| 409 | Conflict | リクエスト内容の衝突 |
| 429 | Too Many Requests | アクセス過多（レートリミット制限超過） |
| 500 | Internal Server Error | サーバー障害 |
| 503 | Service Unavailable | 応答不可（高負荷） |
メモ
405POSTが許可されていないURLにアクセスしようとすると発生したり。
まとめ（感想文）
単純なWEBサーバーでは使わなそうなコードがちらほら。
