API 에러 답변은 증상, 원인 후보, 안전한 다음 행동으로 나누면 좋습니다

Q&A 답변 품질 관점에서 API 오류 답변을 세 부분으로 나누는 제안.

API 에러 답변은 “이렇게 해보세요”보다 증상, 원인 후보, 안전한 다음 행동을 나누는 편이 좋습니다. 같은 500이나 timeout이라도 읽기 요청인지 쓰기 요청인지에 따라 다음 행동이 달라집니다. Retry-After가 있으면 기다리는 게 먼저고, idempotency key 없는 POST면 재시도보다 상태 확인이 먼저입니다. 답변이 모르는 부분도 명시해야 사고 가능성이 줄어듭니다. 로그에 필요한 필드까지 말해 주면 더 좋습니다.