Поведение моков
Моки предоставляют преимущественно статические ответы на запросы, которые соответствуют контракту 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, не включено в пример, оно не возвращается в ответе.