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 CLI 命令行运行


Apifox 使用文档

# Apifox CLI 命令行运行

Apifox CLI 主要用来以命令行方式运行 Apifox 的 测试用例或测试套件。

# 开始

Apifox CLI 依赖于 Node.js >= v10。使用前请先安装 Node.js .

# 安装

使用以下命令安装 Apifox CLI

$ npm install -g apifox-cli

# 导出数据

在 Apifox 的测试用例和测试套件导出Apifox CLI格式数据。

注意

  • Apifox 版本号大于等于 1.0.25 才支持导出Apifox CLI格式数据。
  • 目前仅支持导出数据后离线运行,后续Apifox 开放 API发布后,可以直接运行在线实时数据。

# 运行测试用例或测试套件

$ apifox run examples/sample.apifox-cli.json -r cli,html

运行完成后测试报告会保存在当前目录下的apifox-reports目录里。

# 命令选项

# apifox [options]

  • -h, --help
    使用帮助

  • -v, --version
    显示版本号

# apifox run <file-source> [options]

file-source 为从 Apifox 导出的测试用例或测试套件数据文件存放路径。

更多选项:

  -r, --reporters [reporters]  指定测试报告类型 (default: ["cli"])
  -n, --iteration-count <n>    设置循环次数
  -d, --iteration-data <path>  设置用例循环额数据 (JSON 或 CSV)
  --ignore-redirects           阻止 Apifox 自动重定向返回 3XX 状态码的请求
  --silent                     阻止 Apifox CLI 输出到控制台
  --color <value>              开启/关闭控制台彩色输出 (auto|on|off) (default: "auto")
  --delay-request [n]          指定请求之间停顿间隔 (default: 0)
  --timeout-request [n]        指定接口请求超时时间 (default: 0)
  --timeout-script [n]         指定脚本预执行/后执行接口运行超时时间 (default: 0)
  --verbose                    显示所有接口请求的详细信息
  -h, --help                   使用帮助

# 升级版本

使用以下命令升级 Apifox CLI

$ npm install apifox-cli@latest -g

#

  • 开始
  • 安装
  • 导出数据
  • 运行测试用例或测试套件
  • 命令选项
  • apifox [options]
  • apifox run [options]
  • 升级版本