사용자 지정 목

Apidog는 API 응답을 세밀하게 제어할 수 있는 강력한 목 사용자 지정 기능을 제공합니다. 이 문서에서는 목 데이터를 사용자 지정하는 두 가지 접근 방식을 소개합니다.

필드 수준 사용자 지정: 특정 필드를 제어하면서 다른 필드에는 스마트 목을 사용합니다.

전체 응답 사용자 지정: 기대값을 사용하여 완전한 목 응답을 정의합니다(고정, 조건부 또는 동적).

필드 수준 사용자 지정

때로는 특정 필드에 특정 값을 정의하고, 나머지는 Apidog가 자동으로 생성하도록 해야 할 수 있습니다. Apidog는 필드 수준 제어를 위한 유연한 방법을 제공합니다.

사용자 지정 필드 값 설정

1. 고정 값

엔드포인트 명세의 목 필드에 정적 값을 지정합니다. Apidog는 지정되지 않은 필드에는 스마트 목을 사용하면서, 해당 필드에는 항상 이 정확한 값을 반환합니다.

예:

2. Faker.js를 사용한 동적 값

Apidog의 동적 값(Faker.js 기반)을 사용하여 현실적인 무작위 데이터를 생성합니다. 다음 구문을 사용하십시오.

{{$category.method}}

일반적인 예:

표현식	예시 결과
`{{$person.fullName}}`	Rachel Wheeler
`{{$internet.email}}`	Arno.Huels33@yahoo.com
`{{$commerce.productName}}`	Elegant Plastic Bike

드롭다운 메뉴에서 동적 값을 직접 선택하십시오.

3. 매개변수화된 Faker 메서드

Apidog의 향상된 Faker.js 구문을 사용하여 동적 값 메서드에 매개변수를 전달하고 특수한 데이터 생성을 수행합니다.

예:

사용 사례	표현식	설명
정수 범위	`{{$number.int(min=0,max=10000)}}`	0에서 10,000 사이의 무작위 정수
읽기 쉬운 전화번호	`{{$phone.number(style='human')}}`	사람이 읽기 쉬운 전화번호 형식
N의 배수	`{{$number.int(multipleOf=3)}}`	3으로 나누어떨어지는 정수
배열 요소	`{{$helpers.arrayElement(['red','blue','green'])}}`	배열에서 무작위 색상 선택
날짜 범위	`{{$date.between(from='2024-01-01',to='2024-12-31',format='yyyy-MM-dd')}}`	지정된 범위 사이의 날짜

모듈, 메서드 및 매개변수의 전체 목록은 동적 값 모듈 문서에서 확인하십시오.

4. 여러 표현식 연결

정적 텍스트와 여러 동적 표현식을 결합하여 복잡한 필드 값을 생성합니다.

예: 전체 주소 생성

{{$location.streetAddress}}, {{$location.city}}, {{$location.state}}, {{$location.zipCode}}, {{$location.country}}

샘플 출력:

8507 Hudson Alley, Rochester, Wisconsin, 96512, United States

각 구성 요소는 동적으로 생성되어, 모든 목 API 호출마다 고유하고 현실적인 주소를 생성합니다.

목 로캘

Apidog는 사용자 지정 가능한 목 로캘을 지원하므로, 대상 지역 또는 대상 사용자층에 맞는 다양한 언어와 형식의 동적 테스트 데이터를 생성할 수 있습니다. 목 로캘 구성에 대해 자세히 알아보려면 목 언어(로캘)을 방문하십시오.

전체 응답 사용자 지정(목 기대값)

목 응답을 완전히 제어하려면 목 기대값을 사용하십시오. 이 기능을 사용하면 고정, 조건부 또는 동적 응답을 정의할 수 있습니다.

목 기대값 생성

고정 응답

무조건 기대값을 생성하여 모든 요청에 동일한 데이터를 반환합니다.

단계:

새 기대값을 클릭하십시오.

기대값 이름을 추가하고 조건은 비워 두십시오.

반환하려는 응답 데이터를 입력한 다음 저장하십시오.

제공된 목 URL을 복사하여 이 엔드포인트에 접근할 때 사용하십시오.

조건부 응답

요청 매개변수에 따라 다른 목 데이터를 반환합니다. 목 엔진은 조건을 위에서 아래로 평가하며, 처음 일치하는 기대값을 반환합니다.

지원되는 조건 유형:

매개변수 유형	설명
쿼리 매개변수	URL 쿼리 문자열
경로 매개변수	동적 URL 세그먼트
헤더 매개변수	HTTP 헤더
쿠키 매개변수	쿠키 값
본문 매개변수	JSON 본문 필드(JSON path 사용)

조건 동작

여러 조건은 AND 논리로 결합됩니다(모두 일치해야 함).

일치하는 조건이 없으면 Apidog는 프로젝트 설정 → 기능 설정 → 목 설정의 목 메서드 우선순위로 대체합니다.

제한 사항

본문 매개변수는 XML이 아닌 JSON만 지원합니다.

매개변수 조건에는 {{variables}}를 사용할 수 없습니다.

요청 본문 형식은 API 명세와 일치해야 합니다(예: form-data, JSON).

IP 주소 조건을 사용하여 특정 IP로 응답을 제한할 수 있습니다.

동적 목 데이터

목 기대값은 Faker.js 및 Nunjucks 템플릿 구문을 사용하여 동적이고 무작위화된 데이터를 지원합니다.

예:

{
    "data": [
        {% for i in range(0, 20) %}
        {% if i>1 %},{% endif %}
        {
            "id": {{i}},
            "firstname": "{{$person.firstName}}",
            "lastname": "{{$person.lastName}}"
        }
        {% endfor %}
    ],
    "success": true
}

다음이 생성됩니다:

사용자 객체 20개의 배열(id는 0부터 19까지)

각각 무작위로 생성된 이름과 성 포함

상수 "success": true 필드

구문 참고 사항:

구문	목적
`{{$...}}`	무작위 값을 위해 Faker.js를 호출합니다.
`{% for ... %}`	Nunjucks 반복문 구조
`{{i}}`	Nunjucks 반복 변수(Apidog 변수가 아님)

중요한 차이점

Apidog는 네이티브 Faker.js의 faker.person.firstName() 대신 {{$person.firstName}}을 사용합니다.

Apidog 프로젝트/환경 변수({{variable}})는 목 기대값에서 사용할 수 없습니다.

전체 구문은 Faker.js 및 Nunjucks 문서를 참조하십시오.

고급 기능

사용자 지정 응답 헤더

목 기대값에 사용자 지정 헤더를 추가하여 인증, 페이지네이션 또는 기타 API 동작을 시뮬레이션합니다.

고급 응답 속성

더 보기 탭에서 추가 응답 속성을 구성합니다.

속성	목적	기본값
HTTP 상태 코드	오류 또는 특수 사례 시뮬레이션	200
응답 지연	네트워크 지연 시간 시뮬레이션(밀리초)	0

기대값 활성화/비활성화

기대값 목록에서 로컬 및 클라우드 목 환경에 대해 기대값을 독립적으로 켜거나 끌 수 있습니다.

요약

Apidog의 사용자 지정 목 기능은 다음을 제공합니다.

고정 또는 동적 값을 사용하는 유연한 필드 사용자 지정

목 기대값을 통한 전체 응답 제어

매개변수 기반 응답을 위한 조건부 논리

Faker.js 및 Nunjucks를 사용한 동적 데이터 생성

사용자 지정 헤더, 지연 및 상태 코드를 통한 고급 시뮬레이션

이러한 기능을 통해 프로덕션 동작을 정확하게 반영하는 견고하고 충실도 높은 API 시뮬레이션을 만들 수 있습니다!

필드 수준 사용자 지정#

사용자 지정 필드 값 설정#

1. 고정 값#

2. Faker.js를 사용한 동적 값#

3. 매개변수화된 Faker 메서드#

4. 여러 표현식 연결#

전체 응답 사용자 지정(목 기대값)#

목 기대값 생성#

고정 응답#

조건부 응답#

동적 목 데이터#

고급 기능#

사용자 지정 응답 헤더#

고급 응답 속성#

기대값 활성화/비활성화#

요약#

필드 수준 사용자 지정

사용자 지정 필드 값 설정

1. 고정 값

2. Faker.js를 사용한 동적 값

3. 매개변수화된 Faker 메서드

4. 여러 표현식 연결

전체 응답 사용자 지정(목 기대값)

목 기대값 생성

고정 응답

조건부 응답

동적 목 데이터

고급 기능

사용자 지정 응답 헤더

고급 응답 속성

기대값 활성화/비활성화

요약