OpsxAPI 文档 v1.0

环境与变量

更新于 2026-09-17

前置 URL

环境可配置前置 URL(如 https://api.example.com)。配置后,请求里只需写相对路径:

前置 URL:https://api.example.com
请求路径:/graphql
实际请求:https://api.example.com/graphql
  • URL 输入框会以前缀块 + 路径的形式一体展示,前缀部分不可误编辑(点击可跳转环境管理);
  • 切换环境即自动换成对应服务地址,无需改请求;
  • 路径以 / 开头(或为空)才启用拼接;写完整 https://… 地址的请求不受影响;
  • 未配置前置 URL 的环境,请求仍可写完整 URL 或用 {{变量名}}。

历史数据自动迁移:旧的 {{baseUrl}}/path 会被自动转为「前置 URL + /path」,baseUrl 变量写入环境的前置 URL 字段。

变量语法

在 URL、Params、Headers、Cookies、Body、鉴权字段中,使用双花括号引用变量:

{{baseUrl}}/v1/users?page={{page}}
Authorization: Bearer {{token}}

发送时统一替换为当前启用环境中同名变量的值;未定义的变量保留原样,便于发现遗漏。

切换环境

顶栏环境切换器显示彩色单字徽标 + 环境名 + 变量数,点击弹出环境列表(当前环境带「当前」标记),一眼防误发;底部可进入「管理环境」或「不使用环境」。

管理环境

顶栏 环境 按钮打开管理弹窗(左侧环境列表 + 右侧编辑区):

  • 左栏:环境列表(徽标 + 名称 + 当前标记),底部虚线按钮新建环境。
  • 右栏:提示条(变量引用语法 + 文档直达)、环境重命名、设为当前 / 取消使用、复制环境、删除;变量表支持按名称 / 描述搜索、逐行启用停用、内联编辑。
  • 所有修改即时生效并自动保存。

输入 {{ 自动补全

在 URL 输入框或任意「值」输入框键入 {{,会弹出当前环境的变量浮层:

  • ↑↓ 选择、Enter / Tab 插入完整的 {{变量名}};Esc 关闭。
  • 浮层同时显示变量值,选之前即可确认。

内置示例环境:

环境 baseUrl token
正式 https://httpbin.org demo-token
本地 http://127.0.0.1:8787 dev-token

变量从哪来自动生成

来源 行为
导入 OpenAPI / Swagger servers 地址写入 baseUrl;路径参数 {id} 转为 {{id}} 并写入示例值
导入 Postman collection.variable 写入当前环境
手动输入 在环境面板随时增改

实际地址预览

URL 含 {{ }} 时,编辑器会在 URL 栏下方实时显示替换后的实际地址,切换环境立即更新。

提示:路径参数用变量而不是写死,是接口可复用的关键 —— 复制接口后只改变量值即可调试另一个资源。