← 전체 글로 돌아가기

API

API 응답이 이상할 때 확인하는 순서

API 캐싱이나 응답 문제는 처음부터 정답을 찾으려 하면 시간이 오래 걸린다.

API 응답 문제가 생겼을 때 처음부터 정답을 맞히려고 하면 오히려 확인 시간이 길어진다. 체계적으로 좁혀나가야 한다.

핵심은 한 가지에만 붙잡지 말고 전체 요청/응답 흐름에서 원인을 찾아내는 것이다. 재현 조건, 로그, 응답을 먼저 수집해야 한다.

상황 요약

바로 수정하기 전에 응답 body부터 확인하면 불필요한 변경을 줄일 수 있다. 작은 확인이 쌓이면 원인 후보가 자연스럽게 줄어든다.

증거 모으기

중요한 건 응답 자체보다 재현 가능한 단서를 남기는 것이다. 에러 메시지를 확인하면 다음으로 볼 범위가 확 줄어든다:

  • 먼저 볼 값: 에러 메시지
  • 같이 비교할 값: 정상일 때의 응답
  • 남겨둘 기록: 명령 출력, 응답 코드, 수정한 설정

응답 body와 가능한 원인

정상 상태를 먼저 정해두는 게 좋다. 그래야 인증 상태가 맞는지 아닌지를 빠르게 판단할 수 있다.

curl -i 'https://example.com/api/items?page=1'

가장 작은 실험

요청/응답 작업은 로컬과 운영의 차이가 자주 숨어 있다. 환경 차이까지 같이 적어두면 원인 추적이 쉬워진다.

인증 상태와 통과 기준

바로 수정하기 전에 status code부터 확인하면 불필요한 변경을 줄일 수 있다. 작은 확인이 쌓이면 원인 후보가 자연스럽게 줄어든다.

검증 항목

  1. 원래 증상이 같은 조건에서 다시 나는지 확인한다.
  2. 로그나 응답에서 바뀐 부분을 한 줄로 설명해본다.
  3. 공개 화면, 빌드 결과, 실제 요청 중 하나로 마지막 확인을 한다.

배운 점

요청/응답 작업은 로컬과 운영의 차이가 자주 숨어 있다. 환경 차이까지 같이 기록해두면 원인 추적이 쉬워진다. 작은 확인을 남겨두면 다음 문제를 훨씬 짧게 처리할 수 있다.