Apidog 클라이언트는 HTTP, GraphQL, SOAP, gRPC 및 기타 널리 사용되는 프로토콜로 API 요청을 보내는 기능을 지원합니다. Apidog에서 요청을 생성하고, 응답을 확인하기 위해 전송하며, 팀 협업을 위해 저장할 수 있습니다.새 요청 생성#
Apidog에서 요청을 생성하려면 "+" → **"New Request"**를 클릭하기만 하면 됩니다.요청 메서드, URL, 요청 매개변수, 인증 등 API 사양에 따라 요청의 필요한 부분을 Apidog 인터페이스에 입력할 수 있습니다.이 방법을 사용하여 HTTP, GraphQL, SOAP 요청을 생성할 수 있습니다. WebSocket 및 gRPC 요청 생성에 대한 자세한 내용은 각 프로토콜 문서를 참조하십시오.요청 URL#
Apidog에서 요청을 수행하려면 연결하려는 API 엔드포인트를 나타내는 URL을 지정해야 합니다. API를 사용하여 수행할 수 있는 각 작업은 일반적으로 특정 URL을 가진 엔드포인트와 연결됩니다.API를 빌드하는 경우: URL은 일반적으로 기본 위치와 경로로 구성됩니다. 예를 들어 요청 URL https://api.example.com/user/12에서 https://api.example.com은 기본 URL이고 /user/12는 엔드포인트 경로입니다.
공개 API를 사용하는 경우: API 제공자가 개발자 문서에서 필요한 URL을 제공합니다.
URL 필드에 쿼리 매개변수를 입력하거나 Params 탭에 입력할 수 있습니다. 요청에서 경로 매개변수를 사용하는 경우 URL 필드에 입력할 수 있습니다.프로토콜을 지정하지 않으면 Apidog가 URL 시작 부분에 http://를 자동으로 추가합니다.
요청 메서드#
Apidog에서는 요청 URL의 왼쪽에서 사용할 요청 메서드를 선택할 수 있습니다. 기본 메서드는 GET입니다.일반적인 HTTP 메서드#
| 메서드 | 목적 | 데이터에 미치는 영향 |
|---|
| GET | 지정된 리소스에서 데이터를 검색합니다 | 읽기 전용이며 부작용이 없습니다 |
| POST | 처리할 데이터를 지정된 리소스에 제출합니다 | 새 리소스를 생성합니다 |
| PUT | 기존 리소스를 업데이트합니다 | 전체 리소스를 대체합니다 |
| PATCH | 리소스에 부분 수정을 적용합니다 | 특정 필드를 업데이트합니다 |
| DELETE | 리소스 제거를 요청합니다 | 리소스를 제거합니다 |
API 설계에서 동일한 URL은 서로 다른 메서드로 요청될 수 있으며, 이는 동일한 리소스에 대한 서로 다른 작업을 나타냅니다. 예를 들어 GET /user/{id}는 일반적으로 이 id에 해당하는 사용자 정보를 검색하는 반면, PUT /user/{id}는 이 id에 해당하는 사용자 정보를 업데이트합니다.요청 전송#
요청 프로토콜, 메서드 및 URL을 지정한 후 요청을 전송하려는 API에서 요구하는 기타 세부 정보를 추가하십시오.매개변수 및 본문: 요청과 함께 전송해야 하는 매개변수, 본문 데이터 또는 요청 헤더를 제공하십시오.
인증: 필요한 인증 및 권한 부여를 설정하십시오.
쿠키: Cookies 탭을 선택하여 요청에 쿠키를 사용할 수도 있습니다.
모든 요청 세부 정보를 입력한 후 Send를 선택하여 요청을 API 서버로 전송하십시오. 응답 창에서 서버의 응답을 확인할 수 있습니다.사이드바의 History에서 전송한 요청을 확인하고 다시 전송할 수 있습니다. 이는 디버깅 및 시간 경과에 따른 응답 비교에 유용합니다.