error contract
예외 필터 계약
필터는 오류를 잡는 것에서 끝나지 않는다. 클라이언트가 다음 행동을 고를 수 있도록 상태, 코드, 메시지, 복구 힌트를 일관되게 제공해야 한다.
계약: 분류 가능한 오류 응답사람이 읽고 코드도 분기할 수 있어야 한다.
좋은 오류 계약의 결과
입력 오류입력 오류
필드별 메시지를 보여 주고 사용자가 바로 수정한다.
인증 오류인증 오류
토큰 만료를 감지해 로그인 갱신으로 보낸다.
시스템 오류시스템 오류
내부 상세 대신 추적 번호와 일반 안내를 표시한다.
오류 응답 계약의 필수 칸
| 칸 | 들어갈 값 | 클라이언트 행동 |
|---|---|---|
| status | 400, 401, 403, 404, 409, 500 | 화면 상태와 재시도 여부를 결정한다. |
| code | USER_EXISTS, TOKEN_EXPIRED | 언어와 무관하게 분기한다. |
| message | 사용자에게 보여 줄 설명 | 입력 수정이나 로그인 이동을 안내한다. |
| trace | path, timestamp, request id | 운영 로그와 문의를 연결한다. |