HTTP ステータスコード
API は標準的な HTTP ステータスコードを使用します。以下はよく使われるステータスコードとその意味です。| ステータスコード | 意味 | 説明 |
|---|---|---|
| 200 | OK | リクエストが成功した |
| 201 | Created | リソースが正常に作成された |
| 204 | No Content | リクエストが成功し、コンテンツがない |
| 400 | Bad Request | リクエストに誤りがある(無効なパラメータなど) |
| 401 | Unauthorized | 認証情報が無効または不足している |
| 403 | Forbidden | アクセス権限がない |
| 404 | Not Found | リクエストされたリソースが存在しない |
| 422 | Unprocessable Entity | リクエスト形式は正しいが、意味的に誤っている |
| 429 | Too Many Requests | レート制限を超えている |
| 500 | Internal Server Error | サーバー内部エラー |
エラーレスポンス形式
エラーが発生した場合、API は以下の形式の JSON レスポンスを返します。レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
statusCode | integer | HTTP ステータスコード |
errorId | string | エラーの識別子 |
message | string | エラーの簡単な説明 |
errorDetails | array | 詳細なエラー情報(存在する場合) |
一般的なエラー
認証エラー (401)
権限エラー (403)
検証エラー (422)
エラー処理のベストプラクティス
- すべての HTTP ステータスコードを適切に処理する
- 特に 429 (レート制限) エラーに対しては、リトライロジックを実装する
- エラーメッセージをログに記録して、問題の診断に役立てる
- ユーザーにわかりやすいエラーメッセージを表示する
- センシティブな情報をエラーメッセージへ含めないようにする

