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

# 常见问题

# 1. Apifox 是否收费?

Apifox 采用公网版 (Saas版) 免费,私有化部署版收费。

# 2. 登录(Auth)态如何实现?

请参考文档:登录态(Auth)如何处理

# 3. 接口发送请求前需要调用登录接口获取 token 放在 header,如何实现?

请参考文档:登录态(Auth)如何处理

# 4. B 接口请求参数依赖于 A 接口返回的数据,如何实现?

请参考文档:接口之间如何传递数据

# 5. 同项目下有不同域名的接口,如何处理?

方案一:不同域名的接口,放到不同的项目里。推荐本方案!

方案二:把域名设置成环境变量如DOMAIN_1,接口路径这样填写:https:///users。接口路径是以http://或https://起始的,系统会自动忽略里环境里前置 URL。

方案三:给不同域名接口设置不同环境,通过切换环境来运行不同域名下的接口。不推荐本方案!

# 6. 脚本如何读取或修改接口请求信息?

请参考文档: 脚本读取/修改接口请求信息

# 7. 是否支持查询数据库字段作为参数传给接口?

Apifox 目前还不能直接连数据库,但可以使用类似 xmysql 之类的工具将数据库转成 REST API 来实现。使用方法:

  1. 使用xmysql将mysql数据库生成 REST API,参考文章:xmysql:可为MySql生成REST API的神奇命令 。其他数据库应该也有类似的工具。
  2. 使用预执行脚本的 pm.sendRequest 方法调用上面生成的REST API获取数据,然后写入本地变量(或环境变量/全局变量),参考文档: 脚本使用变量。
  3. 对应的接口参数,直接引用上面的 变量 即可。

# 8. 数据是存储在本地还是云端?可否离线使用?可否私有化部署?

目前 Apifox 暂时目前有 Saas 版 和私有化部署版 。

Saas 版 是免费的,数据都是存在云端的,需要联网才能使用。

私有化部署版 是收费的,数据存在使用者企业内部,不连外网也可以使用。

注意

环境变量/全局变量里的 本地值 仅存放在本地,不会同步到云端,团队成员之间也不会相互同步,适合存放token、账号、密码之类的敏感数据。

# 9. 使用 Postman 调用接口返回正常,而 Apifox 返回错误

解决方法:对比 postman 和 apifox 实际发出的请求内容(url、参数、body、header)是否完全一样。

查看实际请求内容方法:

  1. Apifox:返回内容下的实际请求 tab (老版本为Request tab) 里查看
  2. Postman:点击底部状态栏里的Console查看
  • 1. Apifox 是否收费?
  • 2. 登录(Auth)态如何实现?
  • 3. 接口发送请求前需要调用登录接口获取 token 放在 header,如何实现?
  • 4. B 接口请求参数依赖于 A 接口返回的数据,如何实现?
  • 5. 同项目下有不同域名的接口,如何处理?
  • 6. 脚本如何读取或修改接口请求信息?
  • 7. 是否支持查询数据库字段作为参数传给接口?
  • 8. 数据是存储在本地还是云端?可否离线使用?可否私有化部署?
  • 9. 使用 Postman 调用接口返回正常,而 Apifox 返回错误