Files
opsxapi/apps/server/internal/docs/content/06-env.md
T
logan dec66db5aa feat: OpsxAPI v1.0 全协议接口工作台
- 六协议调试:HTTP/GraphQL/WebSocket/SSE/Socket.IO/MQTT
- 集合树/多标签/多环境变量/历史记录,localStorage 持久化
- 导入:OpenAPI 2/3/3.1、Postman、Apifox、Apipost、cURL、HAR、
  Insomnia、Hoppscotch、Markdown(自动识别,21 个单测覆盖)
- 导出:OpenAPI 3.0 JSON/YAML、Postman v2.1、Markdown 文档、
  全量备份;单请求生成 cURL/fetch/Python/Go 代码
- Gin 服务:HTTP 代理、NDJSON 流式代理(SSE 透传)、
  WebSocket 隧道(浏览器自定义握手 Header)
- 内置产品官网 /home 与用户文档站 /docs(SSR,随二进制交付)
- lucide 图标体系 + 品牌标识(Logo/favicon),明暗双主题
- 环境变量:彩色徽标切换器、管理弹窗、{{ 自动补全
2026-09-18 00:16:59 +08:00

51 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## 变量语法
在 URL、Params、Headers、Cookies、Body、鉴权字段中,使用双花括号引用变量:
```text
{{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 栏下方实时显示替换后的实际地址,切换环境立即更新。
> **提示**:路径参数用变量而不是写死,是接口可复用的关键 —— 复制接口后只改变量值即可调试另一个资源。