エラーハンドリング

本ドキュメントはマイクロサービスのエラーハンドリングポリシーについてまとめています。

新規でプロダクトを作成する際は本ポリシーに従って開発してください。

エラーレスポンス¶

例外発生時は、エラーコード(整数)とエラーメッセージ(文字列)をレスポンスボディに含めてください。

トレーサビリティの向上と統合 UI でアラート表示する際に必要になります。
エラーメッセージはそのままユーザに表示されるので、日本語で記述してください。

{
  "code": XXX, // エラーコード(整数)
  "message": "XXX", // エラーメッセージ(文字列)
}

使うであろうステータスコードを下記にまとめています。

必要があれば、他のものを採用していただいても OK です。ただし、全ステータスコードを 400 に統一するのは避けましょう。

5 桁目はプロダクトごとに割り当てられます。