API를 사용할 때는 요청과 함께 다양한 유형의 데이터를 전송하는 방법을 이해하는 것이 중요합니다. Apidog는 다양한 매개변수와 본문 데이터 유형으로 API 요청을 구성하고 전송할 수 있도록 사용자 친화적인 인터페이스를 제공합니다.매개변수#
매개변수를 사용하면 서버에 추가 정보를 전송할 수 있습니다. Apidog는 두 가지 주요 매개변수 유형인 Query params와 Path params를 지원합니다.Query Params#
쿼리 매개변수는 물음표(?) 뒤의 URL 끝에 추가되며 앰퍼샌드(&)로 구분됩니다. 서버에 선택적 데이터 또는 추가 데이터를 전송하는 데 사용됩니다.Apidog에서는 API 요청에 쿼리 매개변수를 추가하는 두 가지 편리한 방법을 제공합니다.1.
URL에 직접 입력: 주소 표시줄의 URL 끝에 쿼리 매개변수를 직접 추가할 수 있습니다. 예:https://api.example.com/users?page=1&limit=10
2.
Query Params 섹션 사용: Apidog는 URL 입력 필드 아래에 전용 Query Params 섹션을 제공합니다. 여기에서 사용자 친화적인 인터페이스를 사용하여 쿼리 매개변수를 추가, 편집 및 제거할 수 있습니다. 이 섹션에 추가한 매개변수는 요청 URL에 자동으로 추가됩니다.
Query Params의 등호#
일부 특수한 경우에는 쿼리 매개변수가 키-값 쌍으로 표시되지 않을 수 있습니다. 예를 들어 요청 URL은 다음과 같을 수 있습니다.https://api.example.com/users?available
available은 빈 값을 가진 매개변수로 사용될 수 있습니다. 값이 비어 있으면 Apidog는 키와 값 사이의 등호를 자동으로 생략합니다.이 등호를 생략하지 않으려면 수동으로 "Add an equal sign"으로 변경할 수 있습니다.Path Params#
경로 매개변수는 URL 경로 자체의 일부이며 일반적으로 특정 리소스를 식별하는 데 사용됩니다. URL에서 자리 표시자로 표시되며, 보통 중괄호 {}로 감싸집니다.https://api.example.com/users/{userId}
{param}은 실제 값으로 대체됩니다. 이 기능은 URL에 리소스 식별자를 사용하는 RESTful API를 테스트할 때 특히 유용합니다.경로 매개변수에서 변수를 사용해야 하는 경우, 권장되는 방법은 먼저 URL에서 {param}을 사용한 다음 param의 값에 {{variable}}을 사용하는 것입니다.
본문 유형 비교#
다음 표는 사용 가능한 본문 유형을 간략히 비교한 것입니다.| 본문 유형 | Content-Type | 사용 사례 | 파일 업로드 지원 |
|---|
| form-data | multipart/form-data | 파일이 포함된 폼 제출 | ✓ 예 |
| x-www-form-urlencoded | application/x-www-form-urlencoded | 간단한 폼 제출 | ✗ 아니요 |
| JSON | application/json | 구조화된 데이터 교환 | ✗ 아니요 |
| XML | application/xml | 레거시 시스템, SOAP API | ✗ 아니요 |
| raw | Custom (text/plain, etc.) | 사용자 지정 데이터 형식 | ✗ 아니요 |
| binary | application/octet-stream | 파일 업로드, 바이너리 데이터 | ✓ 예 |
| GraphQL | application/json | GraphQL 쿼리/뮤테이션 | ✗ 아니요 |
| msgpack | application/msgpack | 고성능 데이터 전송 | ✗ 아니요 |
Form-data는 HTML 폼을 제출하는 것과 유사하게 키-값 쌍을 전송하는 방법입니다. 이 형식은 다른 데이터와 함께 파일을 업로드해야 할 때 특히 유용합니다.form-data 유형 본문은 요청에서 multipart/form-data로 표시됩니다. 본문의 각 매개변수에 대해 string, integer 등과 같은 유형을 선택할 수 있습니다.form-data에서 JSON 전송: form-data에서 JSON을 전송해야 하는 경우, 매개변수 유형을 string으로 설정한 다음 string 필드에 JSON을 입력해야 합니다.파일 전송: 요청에서 파일을 전송해야 하는 경우, 유형을 file로 선택한 다음 "Upload"를 클릭하여 로컬 파일을 선택하십시오.Apidog는 요청에서 파일만 전송하며 클라우드에 파일을 저장하지 않습니다. 따라서 팀 협업 중에 다른 사용자는 이 요청을 볼 수 있지만 이 파일을 직접 전송할 수는 없습니다. 동료가 해당 파일을 전송할 수 있도록 다른 방법을 통해 이 파일을 전달해야 합니다.
JSON#
JSON은 API 요청 및 응답에 널리 사용되는 데이터 형식입니다. 엔드포인트의 Request → Body → JSON 섹션에서 데이터 스키마를 설계할 수 있습니다.JSON 데이터 스키마를 설계할 때 각 필드를 수동으로 추가하는 대신 Apidog의 Generate from JSON 기능을 사용하여 스키마를 빠르게 생성할 수 있습니다.필드를 수동으로 추가할 때 기본 데이터 유형은 string입니다. 중첩 필드를 추가해야 하는 경우 필드 유형을 object 또는 array로 변경하십시오.JSON에 주석을 추가하려면 Settings → General settings → Feature settings → Advanced settings에서 "JSON with comments support"를 활성화할 수 있습니다. JSON을 전송할 때 이러한 주석은 자동으로 제거됩니다.
XML#
XML(eXtensible Markup Language)은 API 통신에서 사용되는 또 다른 일반적인 데이터 형식입니다. Apidog는 XML 페이로드를 지원하므로 API 요청과 함께 XML 형식의 구조화된 데이터를 전송할 수 있습니다.raw#
raw 옵션을 사용하면 요청 본문에 임의의 사용자 지정 데이터 형식을 전송할 수 있습니다. 이는 다른 옵션에서 다루지 않는 특정 데이터 구조나 형식을 기대하는 API를 사용할 때 유용합니다.binary#
이 옵션을 사용하여 바이너리 데이터를 전송할 수 있으며, 파일을 업로드하거나 바이너리 페이로드를 기대하는 API를 사용할 때 특히 유용합니다. Apidog를 사용하면 API 요청의 일부로 바이너리 파일을 선택하고 전송할 수 있습니 다.GraphQL#
GraphQL을 사용하는 API를 위해 Apidog는 전용 GraphQL 편집기를 제공합니다. 이 기능을 사용하면 구문 강조 표시와 자동 완성 기능을 갖춘 GraphQL 쿼리 및 뮤테이션을 구성하고 전송할 수 있습니다.GraphQL API 작업에 대한 자세한 내용은 Apidog의 GraphQL 문서를 확인하십시오.
msgpack#
MessagePack(msgpack)은 JSON보다 더 compact하고 빠른 바이너리 직렬화 형식입니다. Apidog는 msgpack 데이터 전송을 지원하며, 이는 성능 및 데이터 전송량 감소에 최적화된 API를 사용할 때 유용합니다. 