아피독에서 API를 설계할 때, 많은 수의 요청 매개변수를 추가해야 하는 상황에 직면할 수 있습니다. 수십 개 또는 수백 개의 매개변수가 필요한 엔드포인트를 상상해 보십시오. '편집' 섹션에서 각 매개변수를 개별적으로 추가하는 것은 번거롭고, 시간이 많이 소요되며, 오류가 발생하기 쉽습니다.
다행히도, 아피독은 매개변수를 일괄 추가하는 방법을 제공하여 과정을 보다 원활하고 효율적으로 만들어줍니다.
이 기사에서는 요청 매개변수를 일괄 추가하는 다양한 방법을 살펴보겠습니다. 세부 사항을 살펴보겠습니다.
방법 1: 일괄 편집 기능 사용
본문 매개변수 유형이 form-data 또는 x-www-form-urlencoded일 때, 요청 매개변수를 추가하기 위해 "일괄 편집" 기능을 사용할 수 있습니다.
일괄 편집 기능 접근:
매개변수 목록에서 오른쪽 상단 코너에 있는 "일괄 편집" 버튼을 찾습니다. 이 버튼을 클릭하면 매개변수를 일괄 입력할 수 있는 텍스트 편집 상자가 열립니다.
CSV 형식으로 매개변수 입력:
매개변수는 CSV 형식이어야 합니다. 예를 들어, form-data 매개변수의 경우 요구되는 형식은 다음과 같습니다:
매개변수 이름, 유형, 필수, 예제 값, 콘텐츠 유형, 설명
각 항목은 쉼표로 구분되며 필요 시 비워둘 수 있습니다. AI 도구를 활용하여 이 데이터를 정리하고 오류를 최소화할 수 있습니다. 다음은 예의입니다:
email, string, false, user@gmail.com, text/plain, 사용자의 이메일 주소
password, string, false, ********, text/plain, 사용자의 비밀번호
매개변수를 입력한 후, "OK" 버튼을 클릭하여 해당 요청 매개변수를 생성합니다.
방법 2: 기존 형식에서 매개변수 생성
JSON 또는 XML과 같은 본문 매개변수 유형을 사용하여 작업할 때, 특정 형식으로 내용을 붙여넣어 매개변수를 자동으로 생성할 수 있습니다.
JSON을 사용하여 매개변수 일괄 추가:
매개변수 목록에서 "JSON에서 생성" 버튼을 클릭하면 JSON 객체를 붙여넣거나 입력할 수 있는 텍스트 편집 상자가 열립니다.
JSON의 주석은 매개변수 설명으로 인식될 수 있습니다. 필요에 따라 덮어쓰는 모드 또는 명명 규칙을 지정할 수 있습니다. 다음은 예의입니다:
{"region_id": "82","email": "b.wawjn@gmail.com", // 사용자의 이메일"sales_channel_id": "12","customer_id": "98","country_code": "70", // 국가 코드"context": {"ip": "::1","user_agent": "Chrome"
},// 기타 매개변수...
}
확인하기 전에 입력된 JSON 데이터를 미리 볼 수 있습니다.
편집한 후 "OK" 버튼을 클릭하여 해당 요청 매개변수를 생성합니다.
“자동 생성” 스위치가 켜져 있으면 요청 예시도 생성됩니다.
XML을 사용하여 매개변수 일괄 추가:
JSON과 유사하게 XML 데이터를 편집 상자에 붙여넣을 수도 있습니다. "OK" 버튼을 클릭하여 관련 요청 매개변수를 생성합니다. 다음은 예의입니다:
데이터베이스에서 가져오기:
데이터베이스에 연결하여 원하는 데이터 테이블을 선택함으로써 매개변수를 가져올 수도 있습니다. 데이터베이스의 필드 주석은 설명 또는 이름으로 사용될 수 있습니다.
또한, 매개변수를 생성하기 위해 SQL DDL 문을 입력할 수 있습니다(현재 MySQL만 지원됨). 다음과 같습니다:
CREATE TABLE
carts
(
id int NOT NULL AUTO_INCREMENT,
region_id varchar(10) DEFAULT NULL,
email varchar(255) DEFAULT NULL,
sales_channel_id varchar(10) DEFAULT NULL,
customer_id varchar(10) DEFAULT NULL,
country_code varchar(10) DEFAULT NULL,PRIMARY KEY (
id
)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
방법 3: 일반 매개변수/데이터 모델 추가
아피독은 공통 매개변수 및 데이터 모델을 통해 유사한 API에서 재사용할 수 있도록 미리 정의된 매개변수 템플릿을 만들고 사용할 수 있게 해줍니다.
일반 매개변수 추가:
왼쪽 탐색 모드에서 "설정"을 선택한 후 "공통 매개변수"를 클릭하여 자주 사용하는 매개변수를 추가합니다.
API에서 공통 매개변수를 사용해야 할 때, 매개변수 입력 상자를 클릭하면 미리 정의된 매개변수를 빠르게 선택할 수 있는 선택 패널이 나타납니다.
스키마 추가:
왼쪽 탐색 모드에서 "스키마" 옵션을 찾고, "새 스키마" 버튼을 클릭하여 모델 이름과 설명을 입력한 후 필드를 추가하고 각 필드의 유형, 예제 값, 설명을 정의합니다.
스키마 매개변수는 방법 2에서 언급한 대로 JSON 또는 JSON 스키마를 통해 생성될 수도 있습니다.
요청이나 응답에서 스키마를 사용해야 할 때, 타입(예: 객체)을 클릭하고 팝업 목록에서 "다른 스키마 참조"를 선택하기만 하면 됩니다.
목록에서 미리 정의된 스키마를 선택하면 매개변수가 API에 자동으로 채워집니다.
매개변수를 추가하거나 수정해야 하는 경우, 해당 “데이터 스키마”에서 수정할 수 있으며, 참조 해제할 수도 있습니다. 참조 해제할 경우, 요청 매개변수는 더 이상 공통 데이터 모델에 의존하지 않으며, 독립적으로 존재하고 현재 API에만 속합니다.
방법 4: cURL 명령 가져오기
아피독은 cURL 명령을 직접 가져오는 것을 지원하여 요청 매개변수를 빠르게 설정할 수 있습니다. 특히 Shopify API와 같이 테스트 목적으로 cURL 명령을 제공하는 타사 플랫폼의 API에 유용합니다.
cURL 명령을 가져오려면 제공된 명령을 복사하여 새 API의 주소창에 붙여넣기만 하면 됩니다. 아피독은 cURL 명령을 자동으로 파싱하여 해당 요청 매개변수를 생성합니다.
또한, 프로젝트의 검색 상자 옆에 있는 "+" 버튼을 클릭하고 "cURL 가져오기"를 선택한 후 복사한 명령을 대화 상자에 붙여넣고 "OK"를 클릭할 수 있습니다.
API로 저장하면 JSON 요청 본문이 자동으로 API 문서에 맞추어 구조화됩니다.
결론
이 기사는 아피독에서 요청 매개변수를 일괄 추가하는 다양한 방법을 제시하였습니다. CSV 데이터를 위한 일괄 편집 기능을 사용하거나, JSON 또는 XML 형식에서 매개변수를 생성하고, 데이터베이스에서 가져오거나, 미리 정의된 매개변수 템플릿을 활용하거나, cURL 명령을 직접 가져오실 수 있습니다. 이러한 다양한 접근 방식은 필요에 따라 API 요청 매개변수를 효율적으로 관리할 수 있게 해줍니다.
