API 응답이 예상과 다를 때 확인하는 방법

API 응답이 예상과 다르다면, 혼자 개발할수록 확인한 값과 바꾼 값을 따로 남기는 습관이 중요하다.

핵심은 요청/응답 전체 흐름에서 원인을 찾고, 문제를 체계적으로 좁혀나가는 것이다.

한 줄 요약하기

문제가 뭔지 한 줄로 정의할 수 있는가? "같은 요청에 다른 응답이 온다"가 좋다.

환경 차이를 같이 적어두면 원인 추적이 쉬워진다.

먼저 볼 파일

요청 파라미터가 뭔지 확인한다. 정상일 때 요청과 지금 요청이 정말 같은가?

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

요청을 정확히 기록하고, 응답을 확인한다.

응답 확인

응답 body가 뭔지, 상태 코드가 뭔지 정확히 기록한다.

• 먼저 볼 것: 요청 파라미터와 응답 body
• 비교할 것: 정상일 때의 상태
• 기록할 것: 명령어, 파라미터, 응답

브라우저에서 확인

개발자도구의 네트워크 탭에서 요청과 응답을 확인한다. curl과 브라우저에서 응답이 다를 수도 있다.

인증 상태 확인

같은 사용자로 요청을 했나? 권한이 다르면 응답도 다르다.

에러 메시지를 확인해보면 뭐가 빠졌는지 알 수 있다.

검증

1. 같은 조건에서 요청했을 때 응답이 일정한가 확인한다.
2. 로그에서 뭐가 달라졌는지 정확히 설명한다.
3. 클라이언트에서 새로운 응답 형식으로 제대로 처리할 수 있나 확인한다.

작은 확인이 쌓이면 원인 후보가 자연스럽게 줄어든다. 이번 확인을 기록해두면 다음 문제를 훨씬 짧게 처리할 수 있다.