practical debugging note
API: validation 디버깅 흐름
API 작업에서 validation 문제를 확인할 때 볼 값과 검증 순서를 정리했습니다.
validation 메모 344 기준으로 보면, 운영 중에는 작은 이상 신호도 빨리 분리해서 봐야 한다.
- validation 기준으로 보는 사용자가 보는 모습
- API 관점의 개발자가 보는 신호
- 응답 body 확인과 환경 차이
- API 관점의 수정 전 고정할 값
- 인증 상태 확인과 검증 루틴
validation 메모 344 기준으로 보면, 운영 중에는 작은 이상 신호도 빨리 분리해서 봐야 한다.
핵심은 validation 메모 344에서 한 단어만 붙잡지 않고 요청/응답 전체 흐름에서 원인을 좁히는 것이다. validation 메모 344에서는 재현 조건, 로그, 응답처럼 눈으로 확인할 수 있는 값을 먼저 모은다.
validation 기준으로 보는 사용자가 보는 모습
메모 344의 validation 기준으로 보는 사용자가 보는 모습에서는 요청/응답의 흐름을 먼저 끊어서 본다. 특히 메모 344에서 에러 메시지이 애매하면 다른 부분을 고쳐도 결과가 바뀌지 않을 수 있다.
API 관점의 개발자가 보는 신호
메모 344에서는 바로 수정하기 전에 인증 상태부터 확인하면 불필요한 변경을 줄일 수 있다. 메모 344의 API 관점의 개발자가 보는 신호에서 작은 확인이 쌓이면 원인 후보가 자연스럽게 줄어든다.
- 먼저 볼 값: 인증 상태
- 같이 비교할 값: 정상일 때의 요청/응답 상태
- 남겨둘 기록: 명령 출력, 응답 코드, 수정한 설정
응답 body 확인과 환경 차이
메모 344의 응답 body 확인과 환경 차이에서는 정상 상태를 먼저 정해두는 게 좋다. 그래야 메모 344에서 요청 파라미터 결과가 맞는지 아닌지를 빠르게 판단할 수 있다.
curl -i 'https://example.com/api/items?page=1'
API 관점의 수정 전 고정할 값
메모 344에서 validation 주변 문제가 반복된다면 확인 순서를 고정해두는 편이 낫다. 메모 344의 API 관점의 수정 전 고정할 값을 매번 감으로 접근하면 같은 실수를 반복하게 된다.
인증 상태 확인과 검증 루틴
메모 344의 인증 상태 확인과 검증 루틴에서는 정상 상태를 먼저 정해두는 게 좋다. 그래야 메모 344에서 응답 body 결과가 맞는지 아닌지를 빠르게 판단할 수 있다.
- 원래 증상이 같은 조건에서 다시 나는지 확인한다.
- 로그나 응답에서 바뀐 부분을 한 줄로 설명해본다.
- 공개 화면, 빌드 결과, 실제 요청 중 하나로 마지막 확인을 한다.
API 관점의 운영 메모 · 메모 344
메모 344의 API 관점의 운영 메모 · 메모 344에서는 정상 상태를 먼저 정해두는 게 좋다. 그래야 메모 344에서 에러 메시지 결과가 맞는지 아닌지를 빠르게 판단할 수 있다.
마지막으로, validation 메모 344 기준에서는 해결 자체보다 어떤 값이 달라졌는지 설명할 수 있는 상태가 더 중요하다. 관련 기록을 짧게라도 남겨두면 다음 확인이 훨씬 빨라진다.