Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ユーザー向けエラーコード対応(ドキュメント修正 + 実装) #16

Merged
merged 22 commits into from
Sep 3, 2023

Conversation

ky0yk
Copy link
Owner

@ky0yk ky0yk commented Aug 27, 2023

対応内容

APIドキュメントへの修正

  • 既存情報の見直し

    • リクエストスキーマの命名を見直し
    • タイトルと説明の文字数制限を反映
  • エラーコードを整理

    • ユーザー向けエラーコードという概念を廃止(二重管理が必要なため)
    • 以下のパターンに分けた
      • リクエスト例外
      • アプリケーション例外(回復可)
      • アプリケーション例外(回復不可)
      • システム例外
    • 共通のスキーマを作って、実際のエラーコードはexamplesで定義
      • 1つのHTTPステータスに複数のエラーコードがついても対応できる形
    • 400と422を分離
      close # 18

エラーコードまわりの実装の修正

  • ハンドラ層のエラーハンドラーはAppErrorを引数にするように変更
    • エラーコードに基づいてHTTPステータスを振り分ける
    • エラーメッセージは元のエラーから引き継ぐ
  • エラーコードのフィールドのフィールドを見直し
    • AppErrorはエラーコードを持つが他は持たない
    • readonly化
  • 422対応のためのvalidator改修
  • Content-Typeを返してなかったので返すように修正
  • テスト

@ky0yk ky0yk changed the title APIドキュメントにエラーコードを反映etc. ユーザー向けエラーコード対応(ドキュメント修正 + 実装) Aug 27, 2023
@ky0yk ky0yk merged commit 58a004f into main Sep 3, 2023
1 check passed
@ky0yk ky0yk deleted the docs/error-code branch September 3, 2023 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant