← 전체 글로 돌아가기

API

배포 후 API 연동 문제를 빠르게 찾는 방법

API 요청/응답의 흐름을 체계적으로 확인하면 배포 후의 예상 밖의 문제도 원인을 빠르게 좁힐 수 있다.

API 연동 문제가 나타나면 보통 여러 부분이 동시에 의심스러워 보인다. 문제를 크게 잡으려다가 결국 모든 파일이 의심 대상이 되고, 어디부터 손 봐야 할지 막막해진다. 이럴 때는 한 가지 신호부터 꼭 잡고 시작하는 게 핵심이다.

먼저 응답 body를 확인한다

가장 간단하게 할 수 있는 확인은 API 응답 자체를 보는 것이다. 요청이 실제로 서버에 도달했는지, 응답이 돌아오는지를 먼저 확인하면 나머지 원인을 추적하는 범위가 훨씬 줄어든다.

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

응답 코드(200, 400, 500 등), 응답 body의 구조, 에러 메시지가 있다면 그 내용을 한 줄로 기록한다. 로컬 환경과 운영 환경의 응답을 비교하면 환경 차이로 인한 문제인지 아닌지를 빠르게 판단할 수 있다.

인증 상태부터 확인한다

많은 API 문제는 인증이 제대로 되지 않아서 발생한다. 요청에 포함되는 토큰, 세션, 헤더를 확인한다.

  • 토큰이 만료되지 않았는가
  • 요청 헤더에 올바른 Authorization 값이 포함되어 있는가
  • CORS 설정이 올바르게 되어 있는가

이 세 가지를 확인하는 것만으로도 절반 이상의 배포 후 문제가 해결되는 경우가 많다.

로그에서 바뀐 부분을 한 줄로 정리한다

문제가 발생했을 때의 로그를 정상 상태의 로그와 비교한다. 특히 타임스탬프, 응답 코드, 요청 파라미터가 어떻게 달라졌는지를 눈으로 확인한다. 로그에서 한 줄로 설명할 수 있는 차이를 찾으면, 그게 원인으로 연결되는 실마리가 된다.

공개 URL에서 실제 동작을 확인한다

마지막으로는 브라우저나 실제 앱에서 공개 URL로 동작을 확인한다. 로컬 환경에서는 괜찮았지만 배포 환경에서만 문제가 나는 경우도 많기 때문이다. 실제 사용자 환경에서의 요청/응답 흐름을 한 번 더 검증하면 안심할 수 있다.

다음에 비슷한 문제가 나면

이번에 확인했던 값들(응답 코드, 인증 상태, 로그 차이)을 간단히라도 남겨두면 다음 확인이 훨씬 빨라진다. 같은 문제가 반복되면 이전 기록을 참고해서 같은 단계를 빠르게 지나갈 수 있다.