모의 동작
이 섹션은 모의(mock)가 API Designer에서 사용할 수 있는 다양한 API 정의 요소를 처리하는 방법을 설명합니다.
모의는 API 계약에 해당하는 요청에 대해 주로 정적인 응답을 제공합니다. API에 정의된 보안, 요청 페이로드 또는 요청 헤더에 관계없이 요청에 응답합니다(콘텐츠 협상에 사용되는 Accept 헤더는 제외).
요청이 이루어지면 모의는 사용자가 제공한 항목(예제, 기본값, 열거형 값)을 기반으로 하거나 내장된 예제 값을 사용하여 응답을 생성합니다.
예를 들어 요청이 객체를 반환하는 경우, 객체의 예제가 제공되면 해당 예제가 사용됩니다. 그렇지 않은 경우 각 속성의 예제가 사용되며 이를 바탕으로 JSON 객체가 생성됩니다. 이는 응답 헤더에도 적용됩니다.
응답
- 작업에 응답 범위만 있는 경우 해당 범위의 첫 번째 상태가 반환됩니다. 예를 들어 2XX 응답 범위가 있는 작업은 200 응답을 반환합니다.
- 작업에 특정 응답 코드와 응답 범위 또는 기본 응답이 있는 경우 정의된 코드가 반환됩니다. 예를 들어 201 응답과 3XX 응답 범위가 있는 작업은 201 응답을 반환합니다.
- 작업에 여러 응답 범위가 있고 정의된 응답 상태가 없는 경우 첫 번째 범위의 첫 번째 상태가 반환됩니다. 예를 들어 4XX 및 5XX 응답 범위가 있는 작업은 400 응답을 반환합니다.
- 작업에 기본 응답만 있는 경우 반환되는 응답은 작업 메서드에 따라 다릅니다.
- 사용된 메서드가 POST인 경우 201 응답이 반환됩니다.
- 다른 메서드의 경우 응답 본문이 정의되지 않으면 204 응답이 반환되고, 응답 본문이 정의되면 200 응답이 반환됩니다.
- 작업에 정의된 응답이 없는 경우 200 응답이 반환됩니다.
- 1XX 응답은 모의에서 지원되지 않습니다. 작업에 1XX 응답 범위가 있거나 이 범위에 정의된 응답 코드가 있는 경우 404 응답이 반환됩니다.
조합
- All of: 예제가 정의된 경우 해당 예제가 반환됩니다. 데이터 유형에 대해 정의된 예제가 없는 경우 유형의 속성이 병합되고 속성 수준에서 정의된 예제가 사용되거나 예제 값이 생성됩니다. 속성이 다른 유형에서 두 번 정의된 경우 마지막 값만 유지됩니다. 원시 유형은 삭제되고 객체만 반환됩니다.
- Any of 또는 One of: 예제가 정의된 경우 해당 예제가 반환됩니다. 예제가 정의되지 않은 경우 목록의 첫 번째 유형에서 응답이 생성됩니다.
제한 사항
- Available in request only: 속성이 생성된 예제에서 제외됩니다.
- Available in response only: 속성이 생성된 예제에 포함됩니다.
- Available in request and response: 속성이 생성된 예제에 포함됩니다.
데이터 유형 수준에서 제공된 예제가 속성보다 우선합니다. Available in request only로 정의된 속성이 예제에 포함된 경우 응답으로 반환됩니다. Available in response only 또는 Available in request and response로 정의된 속성이 예제에 포함되지 않은 경우 응답으로 반환되지 않습니다.