여러 요청 본문 예시 구성

Apidog는 JSON, XML, Raw, MsgPack 유형의 요청 본문에 대해 여러 예시를 구성하는 기능을 지원합니다. 이 기능은 다음과 같은 경우에 유용합니다.

다양한 비즈니스 시나리오에 대한 예시 구성: 예를 들어 정상 요청과 예외 요청을 구분할 수 있습니다.

OAS 3.0/3.1 사양 준수: 표준 OpenAPI 사양 내보내기를 지원합니다.

예시 간 빠른 전환: 디버깅 및 자동화 테스트 중에 유용합니다.

여러 요청 본문 예시 구성

Apidog 버전 2.7.0 이상이 필요합니다.

새 요청 본문 예시 생성

엔드포인트 문서의 Edit 페이지로 이동합니다.

Request Body 섹션을 찾습니다.

+ Add 버튼을 클릭하여 새 요청 본문 예시를 생성합니다.

요청 본문 예시 구성

Example Name (선택 사항): 비워 두면 기본값으로 Example 1, Example 2 등이 사용됩니다.

Example Value (필수): 요청 본문에 사용할 실제 예시 데이터를 입력합니다.

Description (선택 사항): 예시를 설명하는 설명을 추가합니다. 서식 있는 텍스트를 위해 Markdown 형식을 지원합니다.

OAS Key (선택 사항): OpenAPI 사양을 내보낼 때 사용됩니다. 입력하지 않으면 일련번호가 대신 사용됩니다.

OAS Extensions (사용자 지정 필드): 입력한 경우 내보내기 중에도 유지됩니다.

요청 본문 예시 저장 및 사용

예시를 저장하면 사용할 수 있게 됩니다. 디버깅 중에는 다양한 예시 중에서 쉽게 선택하여 엔드포인트를 테스트할 수 있습니다.

TIP

Raw 유형의 요청 본문에서는 디버깅 중 첫 번째 예시 값만 표시됩니다.

요청 매개변수를 예시로 추출

디버깅 중 요청 본문을 수동으로 구성했으며 이를 예시로 저장하려면 Extract > **Extract to "Request Example"**를 클릭하기만 하면 됩니다.

추출 옵션 선택

요청 매개변수를 저장하는 방법을 선택하라는 메시지가 표시됩니다.

Overwrite the Example: 이전에 저장한 예시를 대체합니다.

New Example: 완전히 새로운 예시로 저장합니다.

TIP

현재 디버깅 값은 기본적으로 예시에 자동으로 채워집니다.

사용 시나리오

디버깅 중 요청 본문 예시 사용

엔드포인트 문서의 Run 페이지로 이동하여 Auto-generate 섹션을 찾습니다.

드롭다운 메뉴를 클릭하여 요청 본문 예시를 선택합니다. 예시가 자동으로 입력됩니다.

예시 간에 실시간으로 전환하고 선택한 예시로 요청을 보낼 수 있습니다.

고급 설정

Auto-generate 옆의 드롭다운 아이콘을 클릭하면 다음 옵션에 접근할 수 있습니다.

EXAMPLES: 미리 정의된 요청 본문 예시 중에서 선택합니다.

Generate Each Time: mock rules를 기반으로 무작위 값을 자동 생성합니다.

Auto-generation Preference: 더 고급 구성은 Generate Requests를 참조하십시오.

문서 표시

단일 요청 본문 예시의 경우: 예시 이름을 표시하지 않고 간소화된 보기로 표시됩니다.

여러 요청 본문 예시의 경우: 나란히 배치된 레이아웃에서 예시 간 전환이 가능하며, 예시 이름과 Markdown 설명이 표시됩니다.

표시 순서

요청 본문 예시의 표시 순서는 다음 우선순위를 따릅니다.

Example Name > OAS Key > 일련번호(1부터 자동 증가).

비어 있지 않은 항목이 먼저 표시됩니다.

OAS 준수

OAS Key

OAS key는 OpenAPI 사양을 내보낼 때 예시의 필드 이름을 제어합니다.

구성: 요청 본문 예시에 OAS Key를 입력합니다.

내보내기 규칙:

입력한 경우: 입력한 OAS key가 examples 객체 내의 필드 이름으로 사용됩니다.

입력하지 않은 경우: 일련번호(1부터 시작)가 필드 이름으로 자동 사용됩니다.

입력한 경우

입력하지 않은 경우:

 "examples": {
   "example1": {
      "value": {
        "name": "Blake Keeling",
        "id": "165061",
        "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    },
    "example2": {
       "value": {
        "name": "Jolie Kutch",
        "id": "138164",
        "email": "Jolie_Kutch@hotmail.com"
      },
      "summary": "example 2",
      "description": "This is`example 2`"
    }
  }

"examples": {
   "1": {
     "value": {
       "name": "Blake Keeling",
       "id": "165061",
       "email": "Blake.Keeling@gmail.com"
     },
     "summary": "example1",
     "description": "This is`example 1`"
   },
    "2": {
      "value": {
       "name": "Jolie Kutch",
       "id": "138164",
       "email": "Jolie_Kutch@hotmail.com"
     },
     "summary": "example 2",
     "description": "This is`example 2`"
   }
 }

OAS Extensions

예시에 사용자 지정 OpenAPI Specification(OAS) 확장을 추가할 수 있습니다.

구성: OAS Extension 필드에 JSON 키-값 쌍을 입력합니다.

{
  "x-demo": true,
  "x-scenario": "error_case"
}

내보내기 효과: 사용자 지정 OAS 확장은 완전히 보존되며 내보낸 OpenAPI 사양에 포함됩니다.

"examples": {
    "example1": {
      "x-demo": true,
      "x-scenario": "error_case",
      "value": {
         "name": "Blake Keeling",
         "id": "165061",
         "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    }
}

FAQ

이전 프로젝트에서 여러 요청 본문 예시를 활성화하는 방법은 무엇입니까?

수동 작업은 필요하지 않습니다. 기존 엔드포인트에 두 번째 요청 본문 예시를 추가하면 시스템이 여러 예시를 지원하도록 형식을 자동으로 업그레이드합니다.

OAS를 내보낼 때 여러 요청 본문 예시를 처리하는 방법은 무엇입니까?

내보낸 OAS에서 요청 본문 예시의 순서가 변경됩니까?

내보낸 예시 이름을 더 친숙하게 만드는 방법은 무엇입니까?

여러 요청 본문 예시 구성

여러 요청 본문 예시 구성#

요청 매개변수를 예시로 추출#

사용 시나리오#

디버깅 중 요청 본문 예시 사용#

문서 표시#

OAS 준수#

OAS Key#

OAS Extensions#

FAQ#

여러 요청 본문 예시 구성

요청 매개변수를 예시로 추출

사용 시나리오

디버깅 중 요청 본문 예시 사용

문서 표시

OAS 준수

OAS Key

OAS Extensions

FAQ