practical debugging note
에러 타입 API 응답이 바뀔 때 실수 줄이는 방법
API 작업에서 에러 문제를 확인할 때 볼 값과 검증 순서를 정리했습니다.
에러 메모 580 기준으로 보면, 혼자 개발할수록 확인한 값과 바꾼 값을 따로 남기는 습관이 필요하다.
- 에러 기준으로 보는 한 줄 요약
- API 관점의 먼저 볼 파일
- 응답 body 확인과 서버에서 볼 값
- API 관점의 브라우저에서 볼 값
- 인증 상태 확인과 실수 포인트
에러 메모 580 기준으로 보면, 혼자 개발할수록 확인한 값과 바꾼 값을 따로 남기는 습관이 필요하다.
핵심은 에러 메모 580에서 한 단어만 붙잡지 않고 요청/응답 전체 흐름에서 원인을 좁히는 것이다. 에러 메모 580에서는 재현 조건, 로그, 응답처럼 눈으로 확인할 수 있는 값을 먼저 모은다.
에러 기준으로 보는 한 줄 요약
메모 580에서 요청/응답 작업은 로컬과 운영의 차이가 자주 숨어 있다. 메모 580의 에러 기준으로 보는 한 줄 요약을 볼 때는 환경 차이까지 같이 적어두면 원인 추적이 쉬워진다.
API 관점의 먼저 볼 파일
메모 580의 API 관점의 먼저 볼 파일에서는 요청/응답의 흐름을 먼저 끊어서 본다. 특히 메모 580에서 요청 파라미터이 애매하면 다른 부분을 고쳐도 결과가 바뀌지 않을 수 있다.
- 먼저 볼 값: 요청 파라미터
- 같이 비교할 값: 정상일 때의 요청/응답 상태
- 남겨둘 기록: 명령 출력, 응답 코드, 수정한 설정
응답 body 확인과 서버에서 볼 값
메모 580에서는 바로 수정하기 전에 status code부터 확인하면 불필요한 변경을 줄일 수 있다. 메모 580의 응답 body 확인과 서버에서 볼 값에서 작은 확인이 쌓이면 원인 후보가 자연스럽게 줄어든다.
curl -i 'https://example.com/api/items?page=1'
API 관점의 브라우저에서 볼 값
메모 580의 API 관점의 브라우저에서 볼 값에서는 정상 상태를 먼저 정해두는 게 좋다. 그래야 메모 580에서 응답 body 결과가 맞는지 아닌지를 빠르게 판단할 수 있다.
인증 상태 확인과 실수 포인트
메모 580에서는 바로 수정하기 전에 에러 메시지부터 확인하면 불필요한 변경을 줄일 수 있다. 메모 580의 인증 상태 확인과 실수 포인트에서 작은 확인이 쌓이면 원인 후보가 자연스럽게 줄어든다.
- 원래 증상이 같은 조건에서 다시 나는지 확인한다.
- 로그나 응답에서 바뀐 부분을 한 줄로 설명해본다.
- 공개 화면, 빌드 결과, 실제 요청 중 하나로 마지막 확인을 한다.
API 관점의 최종 확인 · 메모 580
메모 580 기준으로 API 쪽 문제는 화면만 보고 판단하면 놓치는 값이 많다. 메모 580의 API 관점의 최종 확인 · 메모 580 단계에서는 로그, 응답, 설정 중 하나를 증거로 잡아야 한다.
마지막으로, 에러 메모 580 기준에서는 작은 확인을 남겨두면 다음 문제를 훨씬 짧게 처리할 수 있다. 관련 기록을 짧게라도 남겨두면 다음 확인이 훨씬 빨라진다.