环境配置

环境用于管理不同服务地址和公共请求配置。为环境配置主机地址、请求头、URL 参数、请求体或前后置脚本后，发送 HTTP 请求时会自动带入这些配置，避免在每个 API 中重复填写相同内容。

常见使用场景：

• 为开发、测试、预发等环境分别配置不同主机地址。
• 为所有请求统一增加 Authorization、Tenant-Id、X-Trace-Id 等请求头。
• 为一批接口统一追加公共 URL 参数，例如 appId、locale、debug。
• 为请求统一补充公共请求体字段。
• 在环境级别配置前置脚本或后置脚本，处理登录态、签名、参数生成或响应数据提取。
• 当 API 路径前缀识别不准确时，在环境中手动配置请求前缀。

请求路径前缀

Cool Request 会尝试识别 Spring Boot 配置中的 server.servlet.context-path，并在每个 API 路径前自动增加该值。

例如项目配置为：

server.servlet.context-path=/api

接口路径为：

/user/list

最终请求路径会按 /api/user/list 发送。

如果 server.servlet.context-path 识别错误，或项目中的路径前缀来自网关、Nginx、启动参数、配置中心等无法自动识别的位置，可以在环境中手动配置前缀。配置后，Cool Request 会按环境中的前缀拼接请求路径。

前缀: /api
接口: /user/list
请求: /api/user/list

全局请求头

环境中可以配置全局请求头。发送请求时，这些请求头会自动应用到使用该环境的 API。

适合放在环境中的请求头通常包括：

• 鉴权信息，例如 Authorization。
• 租户或应用标识，例如 Tenant-Id、App-Id。
• 链路追踪信息，例如 X-Trace-Id。
• 网关或灰度标识，例如 X-Env、X-Version。

示例：

Authorization: Bearer {{token}}
Tenant-Id: 10001
X-Trace-Id: {{uuid}}

如果只有某一个 API 需要额外请求头，可以继续在该 API 的请求头区域单独添加。环境请求头适合保存多个接口都需要复用的公共配置。

全局 URL 参数

环境中可以配置全局 URL 参数。发送请求时，Cool Request 会将这些参数追加到当前请求的查询参数中。

示例：

appId=demo
locale=zh-CN
debug=true

全局 URL 参数适合配置所有接口都需要携带的公共参数。若某个 API 需要自己的参数，仍然可以在 API 的参数区域单独填写。

全局请求体

环境中可以配置全局请求体内容，用于为请求统一补充公共 Body 数据。适合需要在多个接口中固定携带同一段 Body 内容的场景。

例如 JSON 请求可以使用：

{
  "tenantId": "10001",
  "client": "idea"
}

当接口本身也配置了请求体时，请根据实际调试效果确认合并结果是否符合服务端预期。对于复杂的动态 Body，建议使用前置脚本处理。

环境脚本

环境支持配置前置脚本和后置脚本。

前置脚本会在请求发起前执行，可用于：

• 动态生成 token、签名、时间戳或随机值。
• 根据当前环境修改 URL、请求头、URL 参数或请求体。
• 读取环境变量并写入请求。
• 在条件不满足时取消请求。

后置脚本会在响应返回后执行，可用于：

• 从登录接口响应中提取 token，并写入环境变量。
• 解析响应体中的字段，供后续 API 使用。
• 输出调试日志。
• 统一处理响应数据。

环境脚本适合放置多个 API 共用的逻辑。如果只有单个 API 需要特殊处理，可以在该 API 中单独配置前后置脚本。

更多脚本 API 可参考 前/后置脚本。

调试建议

• 首次配置环境后，先选择一个简单 GET 接口发送请求，确认主机地址和路径前缀正确。
• 如果请求地址不符合预期，优先检查环境主机地址、前缀和项目中的 server.servlet.context-path。
• 如果多个 API 都缺少鉴权、租户或公共参数，优先考虑在环境中统一配置。
• 对生产或重要环境进行调试前，确认当前选择的环境、请求参数和脚本逻辑。