Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 入门
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 Apifox
    • 注册与登录
    • 页面布局
    • 基本概念
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 基础知识
      • 接口基本信息
        • 请求 URL 与方法
        • 请求参数与请求体
        • 请求头
        • 请求参数编码解码
        • HTTP/2
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 导入导出数据
      • 概述
      • 手动导入
      • 定时导入
      • 导入设置
      • 导出数据
      • 其它方式导入
        • 导入 OpenAPI/Swagger
        • 导入 Postman
        • 导入 Apipost
        • 导入 Eolink
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 批量管理
    • 数据模型
      • 概述
      • 新建数据模型
      • 通过 JSON 等生成
      • 高级数据类型
      • 构建数据模型
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 全局/环境/临时变量
      • 环境与服务
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SSE 调试
      • SOAP/WebService
      • gRPC 调试
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排测试场景
      • 新建测试场景
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出测试场景数据
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试报告
      • 测试报告
    • API 测试
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
    • Apifox CLI
      • 概述
      • 安装和运行 CLI
      • CLI 命令选项
    • CI/CD
      • 概述
      • 与 Jenkins 集成
      • 与 Gitlab 集成
      • 与 Github Actions 集成
      • 与其它更多 CI/CD 平台集成
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义域名
    • AI 相关特性
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • SEO 设置
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
      • 功能简介
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 团队基本操作
      • 团队成员管理
      • 成员角色与权限设置
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
  • 账号&应用设置
    • 账号设置
    • 语言设置
    • 网络代理
    • 快捷键
    • 数据备份与恢复
    • 更新 Apifox
    • API 访问令牌
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • 目录链接汇总
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
  1. 入门

产品介绍

以往,开发团队在进行 API 设计、管理和测试时,常常需要在多个工具 (比如 Postman 和 Swagger) 之间频繁切换。这种方式不仅容易导致数据同步不一致,还阻碍了团队成员之间的协作,最终影响开发效率。
面对这些问题,如果有一个一体化的平台,能将 API 的设计、开发、测试等所有环节整合在一起,会是多么方便!
在这样的平台上,团队成员可以共享一份清晰的 API 文档,后端开发可以根据接口文档快速开发并调试 API,前端开发可以轻松调用 API 并获取 Mock 数据,测试工程师也能高效地进行 API 测试工作。这样一来,整个团队的协作将会更加顺畅,开发效率也会显著提高。
而 Apifox 正是这样一个一站式 API 开发协作平台!
它集 API 设计、API 开发、API 调试、API 管理、 API 文档、API Mock 和自动化测试等功能于一体,为你的 API 项目提供一站式的解决方案。

Apifox 如何整合你的工作流?#

在 Apifox 中,所有操作都围绕 API 定义 (API specification) 展开。每个角色都可以直接利用设计好的 API 来发送请求、创建接口用例、生成 Mock 数据和发布文档。具体来说:
API 设计者: 可以在 Apifox 中通过可视化界面创建 API,或者导入现有的文件 (例如 OpenAPI/Swagger 的.yaml或.json文件),并支持使用迭代分支来设计 API。
后端开发: 可以直接根据定义好的 API 来发送请求,或生成后端业务代码。
前端开发: 不用等后端完成,可以直接基于 API 定义生成 Mock 数据。
测试工程师: 可以基于 API 定义自动生成接口用例,提供可视化界面来编排测试场景,并集成 CI/CD 流水线。
API 文档维护者: 可以一键生成规范的 API 文档,文档会随 API 定义的更新自动保持同步。
性能测试人员: 提供专门的性能测试功能。
这个工作流程可以带来以下优势:
1.
紧密协作: 促进团队各角色间的高效合作,实现 API 的持续迭代。
2.
有组织的 API 管理: 统一管理 API,避免在多个工具之间频繁切换,提高工作效率。
3.
良好的开发体验: 提供设计优良且文档完善的 API,提升开发者体验,缩短学习曲线。
Apifox 是专门为 API 设计和开发团队量身定制的协作平台。

Apifox 丰富且强大的功能#

Apifox 提供了一系列丰富且强大的功能,帮助你在开发和管理 API 时更加高效:
1.
自动生成请求参数与请求体
根据你定义的接口自动生成对应的请求参数和请求体,不需要手动输入,减少人为错误,确保发送的请求与接口定义完全一致。
2.
自动校验响应
自动检查接口返回的响应,校验响应是否符合预先定义的数据结构,快速发现接口返回与预期不符的情况。
3.
可视化断言和变量提取
通过图形界面创建断言测试,可视化地从接口响应中提取需要的变量。
4.
兼容 Postman 脚本
完全支持并兼容 Postman 格式的脚本,可以直接导入现有的 Postman 脚本,让熟悉 Postman 的团队无缝切换。
5.
执行数据库操作
可以直接连接数据库,并在测试接口时执行数据库操作,支持数据库的增删改查功能。
6.
将请求保存为接口用例
把已调试好的接口请求直接保存,转换为可重复使用的接口用例,方便构建测试集合,编排测试场景。
7.
调用外部程序
支持与多种编程语言集成,帮助团队根据需求扩展功能,自定义工作流程。
8.
兼容微服务场景
适配微服务系统,帮助管理复杂的分布式 API,支持微服务间的切换测试。
9.
自动生成 Mock 数据
根据你定义的接口自动生成 Mock 数据,帮助前端团队独立开发,加速进度。
10.
将快捷请求保存为接口
自动分析已发送的快捷请求,可保存标准的接口文档,简化接口文档维护工作。
11.
可视化编排测试场景
图形化界面编排测试场景,可视化管理测试步骤,支持创建复杂的测试场景。
12.
自托管 Runner Mock
支持在自有服务器部署 Apifox 的 Runner,提供独立的 Mock 服务,满足安全性和性能要求。
每个核心功能都针对 API 开发生命周期中的特定需求,一起构成了一个完整的 API 开发和测试解决方案。
上一页
更新日志
下一页
联系我们
Built with