Skip to content

Roqueman API Client

Roqueman — это API-клиент RoqueOS, своего рода Postman/Insomnia, работающий прямо в вашем веб-рабочем столе. Создавайте и отправляйте запросы HTTP, WebSocket и GraphQL, организуйте всё в коллекции, используйте переменные и окружения, пишите тест-скрипты и автоматизируйте сценарии с помощью цепочки ответов и раннера коллекций — без какой-либо установки.

Roqueman

Чем это полезно

Вы тестируете свои API там же, где уже работаете, а данные синхронизируются с вашим аккаунтом. Без отдельного приложения и без дополнительного входа — откройте Roqueman из Launchpad и начинайте.

Админам: коллекция сервера автоматически

Администраторы с подключённым сервером автоматически получают коллекцию RoqueOS Server (все эндпоинты API сервера) и соответствующее окружение, указывающее на активный сервер — готово к запуску.


Режимы выполнения

Каждый запрос выполняется в одном из трёх режимов (селектор рядом с URL), чтобы обойти CORS в зависимости от сценария:

  • Браузер (Axios) — отправляет прямо из браузера. Идеально для публичных API с включённым CORS. Этот режим необходим для загрузки файлов (браузер формирует multipart/boundary).
  • Сервер (Proxy) — пересылает через ваш RoqueOS Server (требуется подключённый Server Mode). Решает CORS на стороне сервера.
  • Функция (Proxy) — пересылает через Cloud Function RoqueOS (по умолчанию). Решает CORS без собственного сервера.

У каждого запроса есть тайм-аут (по умолчанию 30 с): медленный эндпоинт больше не подвешивает приложение — вы получаете уведомление о тайм-ауте, отличное от ручной отмены.


Создание запроса

  • Метод + URL: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS.
  • Params: таблица ключ/значение строки запроса, с переключателем для каждой строки.
  • Headers: таблица ключ/значение.
  • Body:
    • JSON / XML / Text — редактор с подсветкой синтаксиса.
    • Form (urlencoded) — таблица ключ/значение.
    • Multipart (form-data) — каждая строка переключается между текстом и файлом (с выбором файла). Реальная загрузка файлов требует режима Браузер.
    • Binary — отправляет «сырой» файл с его собственным content-type.
  • Auth: Нет, Bearer, Basic, API Key (header/query), OAuth 2.0 и Digest.
  • Скрипты: пред-запрос и пост-ответ (совместимый с Postman API pmpm.environment.set, pm.test, pm.expect и т. д.).

OAuth 2.0 — получить токен автоматически

В Auth → OAuth 2.0 → Расширенные настройки заполните Token URL, Client ID/Secret и Scope, затем нажмите Получить токен. Roqueman получает токен через client credentials (через режим выполнения вкладки, поэтому прокси решает CORS) и автоматически подставляет Access Token.


Переменные и окружения

Используйте в любом поле (URL, headers, params, body, auth). Порядок разрешения: глобальные → переменные коллекции → активное окружение → рантайм (скрипты). Есть также динамические переменные, такие как , , и др.

Перед отправкой Roqueman предупреждает вас (не блокируя), если какая-то не найдена — чтобы не ушла молча как пустая строка.

Управляйте окружениями через селектор вверху (шестерёнка) — создать, изменить, дублировать, импорт/экспорт и переключение активного окружения.

Цепочка ответ → переменная

На вкладке Извлечь задайте правила сохранения значений ответа в переменные для следующего запроса — без написания скрипта:

  • Откуда: Body (путь JSON, например data.token), Header (имя) или Status.
  • Целевая Переменная + Область (Environment или Global).

После каждого успешного ответа значение извлекается и сохраняется (тост «Переменные сохранены»). Именно это позволяет, например, войти в систему и автоматически использовать полученный токен в последующих запросах.


Коллекции и раннер

Организуйте запросы в коллекции с вложенными папками. Сохраняйте, дублируйте, перемещайте, импортируйте/экспортируйте (формат Postman v2.1, cURL и RoqueOS).

В контекстном меню коллекции пункт Запустить коллекцию открывает раннер: он выполняет все запросы по очереди (корень и папки), запускает тест-скрипты и показывает результат по каждому запросу в реальном времени (статус, время, тесты ✓/✕), а также сводку пройдено/провалено. Цепочка ответ→переменная работает внутри раннера, поэтому сценарии с зависимостями между запросами выполняются от начала до конца.


Ответ

Просмотрщик показывает статус, время и размер, со вкладками Body (с подсветкой и «сырым» режимом), Headers, Cookies и Tests (результаты пост-ответных скриптов). Можно копировать, скачивать и генерировать код запроса на 9 языках (cURL, Fetch, Axios, Python, PHP, Go, Java, C#, Ruby).


WebSocket и GraphQL

Кнопкой + (рядом со вкладками) создайте вкладку WebSocket или GraphQL:

  • WebSocket: подключайтесь, отправляйте текст/JSON и наблюдайте журнал сообщений. При включённом Автопереподключении (по умолчанию) неожиданный обрыв запускает переподключение с экспоненциальной задержкой — ручное отключение не переподключается.
  • GraphQL: редактор query + переменные + интроспекция схемы.

Вкладки и история

  • Вкладки для нескольких запросов с состоянием «не сохранено»; открытые вкладки и черновик переживают перезагрузку (работа не теряется).
  • История отправленных запросов, сгруппированная по дате, с поиском и повтором.

ЧаВо

Не работает загрузка файлов. Переключите режим выполнения на Браузер (Axios) — только он формирует настоящий multipart/form-data. Прокси сервера/функции не пересылает загрузку файлов.

Где хранятся мои данные? Коллекции, запросы, окружения, глобальные переменные и история хранятся в вашем аккаунте (Firebase), синхронизируясь между устройствами. Открытые вкладки остаются в локальном браузере.

Являются ли переменные окружения секретными? Они хранятся как текст в вашем аккаунте. Не помещайте чувствительные продакшен-секреты в общие окружения.

Появилось «тайм-аут». Запрос превысил 30 с. Проверьте эндпоинт, сеть или режим выполнения.