请求工作区与环境
请求工作区是设计好的操作变成真实调用的地方。它通过本地主进程发送请求,显示响应,并用环境和变量管理在不同运行之间变化的值。
发送请求
- 在请求工作区打开一个操作。方法、路径、参数、请求头和请求体都取自规范。
- 填入任何需要具体输入的值,例如路径参数或令牌。
- 发送请求。该标签页会显示状态码、响应头、响应体和耗时。
- 把多个请求保留在标签页中,方便比较或再次查看。
由于执行发生在主进程而非网页视图中,浏览器的直接 CORS 限制不会阻挡你的调用,请求细节也不会通过浏览器网络面板暴露。
环境与 OAS servers 的对比
两者相关但不同,理解它们的区别能消除一个常见困惑来源。
| 自定义环境 | OAS servers | |
|---|---|---|
| 存在位置 | 本地应用设置 | OpenAPI 文档内部 |
| 能否由请求工具写入 | 能 | 不能——用规范补丁修改 |
| 用途 | 新请求标签页和场景运行的默认基础 URL | 契约自身声明的基础 URL |
| 是否随文档共享 | 否 | 是 |
当助手列出基础 URL(env.listServers)时,它先返回你可写的自定义环境,然后是当前文档中声明的只读 servers。
- 要添加或选择本地基础 URL,创建或激活一个自定义环境(
env.upsertServer、env.selectServer)。这从不会 编辑文档。 - 要更改契约中的 servers,改为提出一个规范补丁。
这样把个人调试用的基础 URL 与契约分开,同时仍让文档声明的 servers 驱动请求。
变量
变量跨四个作用域管理:
- globals(全局)——跨所有集合可用;
- collection(集合)——作用于某个集合;
- environment(环境)——绑定到当前环境;除非指定了某个 server,否则应用于每个 server;
- local(本地)——本地会话私有。
助手可以列出变量(env.listVariables,可按作用域过滤)并创建或更新变量(env.setVariable,按名称和作用域 upsert)。变量可以绑定到特定 server,每个变量都有启用状态。设置变量是应用动作,不是对 API 文档的更改。
通常存为变量的值包括访问令牌、跨调用复用的 ID 和功能开关。
当基础 URL 缺失时
请求需要完整 URL。如果文档的 servers 和当前环境都没有提供基础 URL,应用不会猜测——它会在运行前请你提供一个。这比悄悄调用错误的主机更可取。