HTTP ステータスコード
本ドキュメントは REST API の HTTP ステータスコード規約を定義しています。
ステータスコードの定義
| コード | 説明 | 解説 |
|---|---|---|
| 200 | OK | 成功！ |
| 400 | 不正なリクエスト | リクエストが無効です。対応する説明が原因を説明します。 |
| 401 | 未認証 | 認証情報がない、または認証に失敗しました。 |
| 403 | 拒否 | リクエストは理解されましたが、受け入れられませんでした。対応する説明が原因を説明します。 |
| 404 | 見つかりません | リソースが存在しない、リクエストされたユーザーが存在しない、またはリクエストの形式がサポートされていません。 |
| 405 | 不適切なリクエストメソッド | インターフェースがそのメソッドのリクエストをサポートしていません。 |
| 410 | 廃止済み | リクエストされたリソースは廃止されました。関連するお知らせを参照してください。 |
| 429 | リクエストが多すぎます | リクエストが頻度制限を超えました。対応する説明が具体的な原因を説明します。 |
| 500 | サーバー内部エラー | サーバーで内部エラーが発生しました。早急に解決するためにお問い合わせください。 |
| 502 | 無効なゲートウェイ | サービスサーバーが廃止されているか、アップグレード中です。後でもう一度お試しください。 |
| 503 | 一時的なサービス障害 | サーバーがリクエストに応答できません。後でもう一度お試しください。 |
| 504 | ゲートウェイタイムアウト | サーバーは稼働していますが、リクエストに応答できません。後でもう一度お試しください。 |
準拠すべき規約
- 200 は正しい場合にのみ使用してください。すべての例外に 200 を使用しないでください。
- 業務ロジックエラーの場合、できるだけ 4xx の特定のエラーコードを使用し、それ以外の場合は 400 を使用してください。
- サーバー内部エラーの場合、特定のエラーコードがない場合は 500 を使用してください。
- 業務例外が発生した場合、返却内容は JSON フォーマットでエラー情報を定義してください。
