turin.blog
← 전체 글로 돌아가기

practical debugging note

API에서 JSON 응답 다룰 때 체크리스트

API 작업에서 API에서 문제를 확인할 때 볼 값과 검증 순서를 정리했습니다.

빠른 요약

API에서 메모 881 기준으로 보면, 혼자 개발할수록 확인한 값과 바꾼 값을 따로 남기는 습관이 필요하다.

이 글에서 확인할 것
  • API에서 기준으로 보는 처음 보이는 증상
  • API 관점의 원인을 나누는 기준
  • 응답 body 확인과 바로 확인할 값
  • API 관점의 명령으로 보는 방법
  • 인증 상태 확인과 결과를 해석하는 법

API에서 메모 881 기준으로 보면, 혼자 개발할수록 확인한 값과 바꾼 값을 따로 남기는 습관이 필요하다.

핵심은 API에서 메모 881에서 한 단어만 붙잡지 않고 요청/응답 전체 흐름에서 원인을 좁히는 것이다. API에서 메모 881에서는 재현 조건, 로그, 응답처럼 눈으로 확인할 수 있는 값을 먼저 모은다.

API에서 기준으로 보는 처음 보이는 증상

메모 881의 API에서 기준으로 보는 처음 보이는 증상에서는 요청/응답의 흐름을 먼저 끊어서 본다. 특히 메모 881에서 요청 파라미터이 애매하면 다른 부분을 고쳐도 결과가 바뀌지 않을 수 있다.

API 관점의 원인을 나누는 기준

메모 881의 API 관점의 원인을 나누는 기준에서는 요청/응답의 흐름을 먼저 끊어서 본다. 특히 메모 881에서 status code이 애매하면 다른 부분을 고쳐도 결과가 바뀌지 않을 수 있다.

  • 먼저 볼 값: status code
  • 같이 비교할 값: 정상일 때의 요청/응답 상태
  • 남겨둘 기록: 명령 출력, 응답 코드, 수정한 설정

응답 body 확인과 바로 확인할 값

메모 881에서 요청/응답 작업은 로컬과 운영의 차이가 자주 숨어 있다. 메모 881의 응답 body 확인과 바로 확인할 값을 볼 때는 환경 차이까지 같이 적어두면 원인 추적이 쉬워진다.

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

API 관점의 명령으로 보는 방법

메모 881에서 API에서 주변 문제가 반복된다면 확인 순서를 고정해두는 편이 낫다. 메모 881의 API 관점의 명령으로 보는 방법을 매번 감으로 접근하면 같은 실수를 반복하게 된다.

인증 상태 확인과 결과를 해석하는 법

메모 881에서 요청/응답 작업은 로컬과 운영의 차이가 자주 숨어 있다. 메모 881의 인증 상태 확인과 결과를 해석하는 법을 볼 때는 환경 차이까지 같이 적어두면 원인 추적이 쉬워진다.

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

API 관점의 마지막 점검 · 메모 881

메모 881의 API 관점의 마지막 점검 · 메모 881에서는 정상 상태를 먼저 정해두는 게 좋다. 그래야 메모 881에서 요청 파라미터 결과가 맞는지 아닌지를 빠르게 판단할 수 있다.

마지막으로, API에서 메모 881 기준에서는 한 번에 여러 설정을 바꾸지 않는 것만으로도 원인 추적이 쉬워진다. 관련 기록을 짧게라도 남겨두면 다음 확인이 훨씬 빨라진다.