Skip to content

Roqueman API Client

Roqueman 是 RoqueOS 的 API 客户端 —— 一个运行在你的 Web 桌面里的 Postman/Insomnia。构建并发送 HTTPWebSocketGraphQL 请求,用集合组织一切,使用变量与环境,编写测试脚本,并通过响应链式传递集合运行器自动化流程 —— 无需安装任何东西。

Roqueman

为什么有用

你在已有的工作环境中测试 API,数据同步到你的账户。无需单独的应用,无需额外登录 —— 从 Launchpad 打开 Roqueman 即可开始。

管理员:自动加载服务器集合

已连接服务器的管理员会自动加载 RoqueOS Server 集合(服务器 API 的所有端点),并附带一个指向当前服务器的环境 —— 开箱即用。


执行模式

每个请求在三种模式之一(URL 旁的选择器)下运行,以按场景绕过 CORS:

  • 浏览器 (Axios) —— 直接从浏览器发送。适合启用了 CORS 的公共 API。这是文件上传所需的模式(由浏览器生成 multipart/boundary)。
  • 服务器 (Proxy) —— 通过你的 RoqueOS Server 转发(需连接 Server Mode)。在服务器端解决 CORS。
  • 函数 (Proxy) —— 通过 RoqueOS Cloud Function 转发(默认)。无需自有服务器即可解决 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 的 pm API —— pm.environment.setpm.testpm.expect 等)。

OAuth 2.0 —— 自动获取令牌

Auth → OAuth 2.0 → 高级设置 中,填写 Token URLClient ID/SecretScope,然后点击获取令牌。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(带高亮和原始模式)、HeadersCookiesTests(响应后脚本结果)标签页。你可以复制下载并以 9 种语言(cURL、Fetch、Axios、Python、PHP、Go、Java、C#、Ruby)生成代码


WebSocket 与 GraphQL

使用标签页旁的 + 按钮创建 WebSocketGraphQL 标签页:

  • WebSocket:连接、发送文本/JSON 并查看消息日志。开启自动重连(默认)时,意外断开会以指数退避触发重连 —— 手动断开则不会重连。
  • GraphQL:query 编辑器 + 变量 + schema 内省。

标签页与历史

  • 多请求标签页,带“未保存”状态;打开的标签页和草稿在重新加载后仍保留(不会丢失工作)。
  • 已发送请求的历史,按日期分组,可搜索和重放。

常见问题

文件上传不工作。 把执行模式切换到浏览器 (Axios) —— 只有它才会构建真正的 multipart/form-data。服务器/函数代理不转发文件上传。

我的数据保存在哪里? 集合、请求、环境、全局变量和历史保存在你的账户(Firebase)中,跨设备同步。打开的标签页保存在本地浏览器。

环境变量是机密吗? 它们以文本形式保存在你的账户中。不要把敏感的生产机密放在共享环境里。

它提示“超时”。 请求超过了 30 秒。请检查端点、网络或执行模式。