← 전체 글로 돌아가기

API

API 검증 순서를 체계적으로 잡기

검색으로 찾은 해결책도 로컬에서는 작동하는데 배포 환경에서는 다를 수 있다. 요청과 응답의 흐름을 정확히 이해하면 시간을 절약할 수 있다.

API 검증 로직을 수정한 후 로컬에서는 완벽한데 배포 환경에서 자꾸 실패한다는 피드백이 들어왔다. 로컬과 운영 환경의 데이터 상태가 다를 수 있다는 걸 깨달았다.

요청과 응답 전체 흐름에서 원인을 좁혀가는 게 핵심이다. 한 부분만 집중하면 놓치는 게 많다.

먼저 목표를 명확히 하기

API가 무엇을 해야 하는지 정확히 정의하고, 그에 맞는 응답이 오는지 확인한다.

  • HTTP 상태 코드
  • 정상일 때의 요청/응답 상태
  • 기록할 사항: 명령어 출력, 상태 코드, 설정 변경사항

응답 body를 자세히 보기

상태 코드만으로는 부족하다. 실제 응답 데이터가 기대한 형식인지 확인해야 한다. 특히 에러 메시지가 명확하면 다음 단계가 쉬워진다.

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

인증과 권한 확인하기

  1. 같은 조건에서 에러 반복
  2. 로그와 응답의 변화 정리
  3. 실제 환경에서 최종 테스트

작은 확인을 남겨두면 다음 문제를 훨씬 짧게 처리할 수 있다.