Apifox 使用文档

vuePress-theme-reco Apifox 使用文档    2021
Apifox 使用文档 Apifox 使用文档

Choose mode

  • dark
  • auto
  • light
文档
建议反馈
下载 Apifox

Apifox 使用文档

0

Article

0

Tag

文档
建议反馈
下载 Apifox
  • 介绍

    • Apifox 介绍
    • 快速上手
  • 接口管理

    • 接口设计 (接口文档)
    • 接口调试 / 接口用例
    • 数据结构 / 数据模型
    • 快捷调试
    • 环境管理
    • 环境变量 / 全局变量 / 本地变量
    • 动态变量 / 随机参数
  • Socket 接口

    • Socket 接口快速上手
    • 报文数据处理器
  • 最佳实践

    • 团队协作流程
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
  • 使用脚本

    • 脚本介绍
    • 预执行脚本
    • 后执行脚本 (断言测试)
    • 公共脚本
    • 脚本 API 参考

      • pm 对象 API
      • 内置 JS 类库
      • 脚本调用其他语言( java、python、php 等)
    • 脚本示例

      • 断言 (测试请求结果)
      • 脚本使用变量
      • 脚本读取/修改接口请求信息
      • 其他示例
  • Mock 数据

    • Mock 功能说明
    • Mock 语法
    • 智能 Mock
  • 测试管理

    • 测试用例
    • 测试套件
    • 性能测试
    • 对比测试 (todo)
  • 持续集成

    • 持续集成
  • 代码生成

    • 代码生成
  • 导入/导出

    • 导入数据
    • 导入抓包数据 (cURL)
    • 导出数据
  • Apifox CLI

    • Apifox CLI 命令行运行
  • Apifox API

    • Apifox 开放 API (todo)
  • 插件

    • 插件安装、开发 (todo)
    • 数据导入插件 (todo)
    • 数据导出插件 (todo)
  • 更多功能

    • 快捷键
    • 私有化部署
  • 参考资料

    • JSON Schema 介绍
    • Socket 粘包和分包问题
    • 安装 Java 环境
  • 其他

    • 常见问题
    • 后续功能规划
    • 更新日志
    • 联系我们

vuePress-theme-reco Apifox 使用文档    2021

环境管理


Apifox 使用文档

# 环境管理

一个项目在不同的阶段会处于不同的环境中,比如开发环境、测试环境、生产环境,通常不同的环境有不同的前置 URL、接口参数等。因环境不同而频繁的更改接口前置 URL 及参数,是非常的麻烦的。有了环境管理功能,只需在不同的环境设置不同的前置 URL 及参数,在不同环境中测试时,直接切换环境即可。

# 快速上手

  1. 打开环境管理(软件右上角设置形状的按钮)。

  2. 打开环境管理界面后,即可在这里新建或修改环境。

# 功能点说明

  1. 前置 URL:接口运行时自动添加到接口路径前组成接口实际请求的 URL,如前置 URL 为https://www.api.com,接口路径为/pets/123,那么实际请求的 URL 为https://www.api.com/pets/123。
  2. 环境变量:跟随环境切换而发生改变的变量,具体说明可以查看文档 环境变量/全局变量/本地变量。
  3. 额外参数:当前环境下,给所有接口请求额外加上参数。注:额外参数的参数值可以引用环境变量/全局变量/本地变量。

注意

  1. 前置 URL 末尾建议不要加上斜杠/,接口设计时 接口路径 建议以斜杠/起始。
  2. 如果接口路径本身就以http://或https://起始,实际发出请求的时候不会自动加上前置 URL。但通常不建议这么使用。

注意

  • 系统内置名为BASE_URL的特殊环境变量,其值为当前环境的前置URL,使用方式{{BASE_URL}}。
  • 如用户手动添加了名为BASE_URL的环境变量,则会覆盖掉系统内置BASE_URL的值。
  • 脚本可通过 pm.environment.get('BASE_URL') 方式读取前置URL。
  • 脚本不能修改前置URL,脚本 pm.environment.set('BASE_URL','xxx')会生成一个真正的名为BASE_URL的环境变量,而不会修改前置URL。
  • Apifox 版本号大于等于 1.0.12 才支持内置BASE_URL。

# 环境变量使用

查看文档

  • 快速上手
  • 功能点说明
  • 环境变量使用