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 使用文档

# 持续集成

Apifox 的测试用例和测试套件支持导出Apifox CLI、Postman、Jmeter 格式数据做持续集成。

# 一、Apifox CLI 方式

Apifox CLI 是 Apifox 的命令行运行工具,主要用来做持续集成。

注意

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

# 导出数据

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

# 安装 Apifox CLI

使用以下经命令安装 Apifox CLI

npm install -g apifox-cli

# 运行

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

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

查看Apifox CLI 使用说明。

# 二、Newman 方式(Postman)

使用参考教程:Web API 持续集成:PostMan+Newman+Jenkins(图文讲解)

# 三、JMeter 方式

导出 JMeter 数据主要用来做性能测试,不过也可以做持续集成,参考教程:性能测试与持续集成(JMeter+Jenkins)

注意

由于 JMeter 不支持 JS 脚本,所以 Apifox 导出 JMeter 数据不包含预执行脚本和后执行脚本。

后续 Apifox 会将接口返回数据提取和断言功能做成界面配置,这样就可以做到导出数据和 JMeter 兼容了。

  • 一、Apifox CLI 方式
  • 导出数据
  • 安装 Apifox CLI
  • 运行
  • 二、Newman 方式(Postman)
  • 三、JMeter 方式