페이지 이동경로
  • 문서>
  • 도구>
  • REST API 테스트

도구

REST API 테스트

이 문서는 카카오디벨로퍼스에서 제공하는 REST API 테스트 도구를 소개합니다.

기능 소개

카카오디벨로퍼스는 REST API를 개발하고 디버깅할 때 유용한 REST API 테스트 도구를 제공합니다.

[도구] > [REST API 테스트]에서 이용할 수 있습니다.

화면 설명

REST API 테스트 도구 화면 상세 첫 번째

🅐 API 목록: 테스트할 API 선택 🅑 앱: 예제인 [developers-sample]로 기본 설정, 앱 이름 옆의 목록 버튼을 눌러 원하는 앱으로 변경 가능 🅒 API 정보: 현재 선택한 API 기능 설명 🅓 인증: 요청 헤더(Header)에 사용할 인증 정보 선택, 액세스 토큰 또는 앱 어드민 키, 액세스 토큰은 [토큰 발급]을 눌러 발급 가능 🅔 파라미터: 필요한 파라미터 값 설정

REST API 테스트 도구 화면 상세 두 번째

🅕 요청: 현재 선택한 API 파라미터 설명 🅖 응답: 현재 선택한 API 요청 결과로 받는 응답의 구성 요소 설명

REST API 테스트 도구 화면 상세 세 번째

🅗 응답 예제: 참고용 기본 응답 예제

사용 방법

  1. 🅓 인증 방식을 선택합니다. 액세스 토큰 또는 어드민 키를 사용할 수 있습니다. 액세스 토큰 선택 시, 토큰으로 조회할 수 있는 사용자 정보 범위를 선택할 수 있습니다.
  2. 요청에 필요한 🅕 파라미터를 설정합니다. *가 붙은 파라미터는 필수 파라미터로 반드시 설정해야 합니다.
  3. [전송]을 눌러 설정한 정보로 API 요청을 보냅니다.

요청 예시와 이에 대한 응답을 확인할 수 있습니다.

REST API 테스트 도구 화면 상세 응답 정보

🅘 HTTP 상태 코드(Status code): API 요청 결과로 받은 응답의 HTTP 상태 코드, 응답 코드 참고 🅙 응답 본문(Body): API 요청 결과로 받은 응답 본문 🅚 요청 예제: 사용자의 개발 환경에서 직접 요청해 보는 데 사용할 수 있는 예제

도구> REST API 테스트