Рабочая область запросов и окружения
В рабочей области запросов спроектированная операция становится реальным вызовом. Запрос отправляется через локальный главный процесс, ответ отображается в интерфейсе, а окружения и переменные задают значения, меняющиеся между запусками.
Отправка запроса
- Откройте операцию в рабочей области запросов. Метод, путь, параметры, заголовки и тело берутся из спецификации.
- Заполните значения, требующие конкретного ввода, например параметр пути или токен.
- Отправьте запрос. На вкладке появятся код состояния, заголовки, тело и время выполнения.
- Держите несколько запросов открытыми во вкладках, чтобы сравнивать их или возвращаться к ним.
Поскольку выполнение происходит в главном процессе, а не в веб-представлении, ограничения CORS браузера не блокируют вызовы, а подробности запроса не отображаются в сетевой панели браузера.
Окружения и серверы OAS
Это связанные, но разные понятия. Понимание разницы помогает избежать распространённой путаницы.
| Пользовательское окружение | OAS servers | |
|---|---|---|
| Где хранится | В локальных настройках приложения | В документе OpenAPI |
| Можно изменить инструментами запросов | Да | Нет: нужна правка спецификации |
| Назначение | Базовый URL по умолчанию для новых вкладок запросов и запусков сценариев | Базовые URL, объявленные в самом контракте |
| Передаётся вместе с документом | Нет | Да |
Когда ассистент перечисляет базовые URL (env.listServers), сначала он возвращает изменяемые пользовательские окружения, а затем серверы из активного документа, доступные только для чтения.
- Чтобы добавить или выбрать локальный базовый URL, создайте или активируйте пользовательское окружение (
env.upsertServer,env.selectServer). Документ при этом не меняется. - Чтобы изменить серверы в контракте, предложите правку спецификации.
Так личный URL для отладки остаётся отдельно от контракта, а серверы, объявленные в документе, по-прежнему можно использовать для запросов.
Переменные
Переменные имеют четыре области действия:
- globals — доступны во всех коллекциях;
- collection — ограничены одной коллекцией;
- environment — связаны с активным окружением; действуют для всех серверов, если конкретный сервер не указан;
- local — принадлежат только локальной сессии.
Ассистент может перечислять переменные (env.listVariables, при необходимости с фильтром по области) и создавать или обновлять их (env.setVariable, по имени и области). Переменную можно привязать к определённому серверу; у каждой есть признак включения. Настройка переменной меняет состояние приложения, а не документ API.
В переменных обычно хранят токены доступа, идентификаторы для повторного использования в вызовах и флаги функций.
Если базовый URL отсутствует
Запросу нужен полный URL. Если ни servers документа, ни активное окружение не задают базовый URL, приложение попросит указать его перед запуском, а не будет молча обращаться к неподходящему хосту.