API 모의 서버를 사용한 응답 생성
API 모의 서버를 활성화하면 즉시 사용할 수 있습니다.
API 모의 서버는 수신하는 모든 호출에 대해 최대한 사실적으로 응답합니다. 응답 본문을 생성할 때 모의 서버는 예제 필드, 기본값, 열거형(enum) 필드 순으로 검색하여 사용자가 제공한 데이터에 우선순위를 둡니다. 해당 항목이 발견되면 예제로 사용되고, 그렇지 않으면 호출된 작업에서 반환된 데이터 유형을 기반으로 JSON 예제가 생성됩니다.
예를 들어 아래에 표시된 Company 데이터 유형 정의를 살펴보겠습니다. 여기에는 사용자가 제공한 예제가 포함되어 있지 않습니다.
모의 서버가 활성화되면 /company/{companyId} 리소스에 대한 GET 호출은 데이터 유형의 구조를 기반으로 자동 생성된 JSON 응답을 반환합니다.
모의 서버는 사용자 지정 응답 헤더(예: x-my-custom-header)에 대한 값 생성, 배열 식별 및 적절한 예제 생성(예: tags 속성), 중첩된 구조 식별 및 해당 값 생성(예: address 속성)을 포함하여 여러 가지 흥미로운 작업을 수행했습니다.
API Designer 모의 서버는 콘텐츠 협상을 지원하므로 Accept 요청 헤더를 사용하여 여러 옵션(각각 고유한 예제가 있을 수 있음) 중에서 반환할 본문을 선택할 수 있으며, 이에 따라 모의 서버에서 반환하는 예제가 변경됩니다.
정보 메모참고: API 모의 서버를 호출할 때 응답 헤더 이름의 대소문자가 변경될 수 있습니다. HTTP 헤더 이름은 대소문자를 구분하지 않으므로 이로 인해 문제가 발생하지는 않습니다.