Инструменты API
Выберите операцию и тело, затем используйте пример или генерацию по схеме.
Спецификация и тела остаются в этом браузере; запросы к API не отправляются.
Чтение операций…
Моки OpenAPI нужны, когда интерфейс уже пора тестировать, а серверный метод ещё не готов. Каждый набор данных связан с операцией и статусом в контракте. Это помогает не превратить успешный ответ в ошибку, случайно сохранив недопустимые поля.
Генерация моков по схеме различает количество полных тел и длину массива внутри ответа. Первое задаётся в настройках пакета, второе определяется items и ограничениями схемы. Изменение числа образцов не переписывает контракт массива.
Моки OpenAPI можно подготовить для объявленного ответа 400 или 404 так же, как для 200. Именованный пример выбирается в рамках конкретного статуса и типа содержимого. Не приходится менять исходную спецификацию или смешивать примеры разных ответов.
Отключите приоритет примеров и зафиксируйте seed. Одинаковые документ и настройки дадут ту же последовательность при той же версии движка. Явный пример или константа могут не меняться при другом seed: их фиксированное значение задано самим контрактом.
Начальный пример YAML автоматически заполняет списки операций. Для запроса обрабатывается только requestBody, для ответа — выбранные статус и тип содержимого. Параметры пути, строки запроса и заголовков в результат не входят.
example и именованные examples на уровне типа содержимого имеют приоритет над примерами схемы и свойств. Неверный пример вызывает ошибку, а не незаметную замену случайными данными. Чтобы исследовать допустимые значения схемы, отключите приоритет.
Один результат JSON сохраняет исходную форму тела. Несколько результатов получают внешний массив, а JSONL содержит по одному целому телу в строке. Ctrl/Cmd + Enter запускает генерацию. После изменений экспорт блокируется до нового успешного запуска.
Найдите операцию по методу и пути, затем выберите код ответа, диапазон или default. Сначала выбирается 200, затем другой 2xx, затем первая запись. Генерация ответов для ошибок использует тот же понятный выбор, что и успешный сценарий.
Поддерживаются встроенные значения, именованные примеры и локальные ссылки на Example Object. Применяются подходящие примеры схемы и свойств. Каждое тело проверяется перед экспортом: наличие данных в examples само по себе не гарантирует их корректность.
Из запросов исключаются свойства readOnly, из ответов — writeOnly. Соответствующие требования required корректируются для этого направления. Если предоставленный пример содержит исключённое поле, он отклоняется без скрытого удаления данных.
Можно создать от 1 до 100 независимых полных тел. uniqueItems требует уникальности элементов массива внутри одного тела, но не всех образцов пакета. Количество образцов не меняет ограничения вложенных массивов.
Вставьте полный поддерживаемый документ, выберите операцию, направление и тип содержимого. Для документированных значений оставьте приоритет примеров, для выборки по схеме отключите его. Отдельную схему можно использовать в специальном генераторе данных по схеме.
Сначала укажите статус и JSON-тип содержимого, затем именованный пример в этом месте документа. Допустимы встроенные значения и локальные ссылки на Example Object. Пример типа содержимого важнее примера схемы.
Да, если операция объявляет нужный ответ с поддерживаемой JSON-схемой. Выберите 400 или 404 и получите соответствующее тело как фикстуру. Настоящий HTTP-ответ не отправляется, сбой сервера не моделируется.
Начальный seed равен 42. Одинаковые документ и параметры воспроизводят выборку. example, const и enum с единственным значением могут оставаться одинаковыми при любом seed. Для сравнения разных seed сначала отключите приоритет примеров.
Нет. Проверяется предоставленное или сгенерированное тело относительно поддерживаемой эффективной схемы. Инструмент не обращается к API, не выполняет middleware и не проверяет реальные заголовки, авторизацию или бизнес-правила.
Какое ещё ограничение вам нужно?
Сначала создайте моки OpenAPI в количестве одного тела, проверьте выбранный статус и источник данных, затем увеличивайте пакет под задачу теста.