Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 开发和调试 API
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 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

开发和调试 API

Apifox 旨在简化和高效地进行 API 调试,优化测试和开发流程。以下是 Apifox 核心调试功能的概述。

自动生成请求#

Apifox 可以根据你的 API 定义自动生成请求参数和请求体,从而提高调试过程的准确性和效率。
自动生成请求参数与请求体
根据你定义的接口自动生成对应的请求参数和请求体,不需要手动输入,减少人为错误,确保发送的请求与接口定义完全一致。
通过“动态值”生成数据
向请求中注入真实的动态值,模拟实际场景,帮助识别数据变更处理中的潜在问题。
将请求保存为接口用例
把已调试好的接口请求直接保存,转换为可重复使用的接口用例,方便构建测试集合,编排测试场景。

便捷的可视化调试#

通过 Apifox,你可以直观的调试你的接口,无需手动设置,确保 API 在不同场景下按预期工作。
自动校验响应
自动检查接口返回的响应,校验响应是否符合预先定义的数据结构,快速发现接口返回与预期不符的情况。
可视化断言和变量提取
通过图形界面创建断言测试,可视化地从接口响应中提取需要的变量。
兼容 Postman 脚本
完全支持并兼容 Postman 格式的脚本,可以直接导入现有的 Postman 脚本,让熟悉 Postman 的团队无缝切换。

独特功能#

Apifox 提供独特的功能组件,使其在同类产品中脱颖而出,能够进行更全面的 API 测试,特别适合复杂项目。
执行数据库操作
可以直接连接数据库,并在测试接口时执行数据库操作,支持数据库的增删改查功能。
调用外部程序
支持与多种编程语言集成,帮助团队根据需求扩展功能,自定义工作流程。
兼容微服务场景
适配微服务系统,帮助管理复杂的分布式 API,支持微服务间的切换测试。

其他功能#

Apifox 还提供额外的功能组件和调试模式,以提升你的调试体验和 API 开发工作流。
文档/调试模式
支持在文档模式与调试模式之间自由切换,方便专注于撰写 API 定义或调试 API。
代码生成
根据 API 定义自动生成请求代码和业务逻辑代码。
将快捷请求保存为接口
自动分析已发送的快捷请求,可保存标准的接口文档,简化接口文档维护工作。

不同团队的最佳实践#

对于以 API 设计为先的团队#

一旦 API 设计完成,后端开发团队可以利用 API 定义 (API specification) 进行 API 的开发与调试。Apifox 提供以下开发和调试功能:

开发前#

代码生成
根据 API 定义自动生成请求代码和业务逻辑代码。

开发后#

生成并发送 API 请求
根据 API 定义生成请求。
通过“动态值”生成数据
向请求中注入真实的动态值,模拟实际场景,帮助识别数据变更处理中的潜在问题。
环境与服务
支持不同环境和服务的配置,允许开发者在开发、测试和生产环境之间切换。该功能为在各种条件下测试 API 提供了灵活性。
自动校验响应
自动检查接口返回的响应,校验响应是否符合预先定义的数据结构,快速发现接口返回与预期不符的情况。
前后置操作
允许定义在发送 API 请求前后可以执行的脚本、断言、提取响应数据等操作。这些操作可以包括数据处理、错误处理或 API 响应处理等。
使用脚本
开发者可以编写和执行脚本,实现高级定制和自动化的 API 开发与测试任务。脚本可用于执行复杂操作、与外部系统交互,或增强 API 请求和响应的功能。
接口用例
Apifox 中的接口用例是针对特定 API 接口预定义的测试用例,用于简化创建、管理和执行 API 测试的过程,以及将其集成到自动化测试工作流中。

对于以代码为先的团队#

如果你的团队采用代码优先的开发方法,Apifox 提供了一系列支持这一工作流程的工具:
IDEA 插件
可以在 IDEA 环境中识别本地 Java、Kotlin 后端项目的源代码,自动生成 API 文档并一键同步到 Apifox 的项目中。
定时导入
提供自动从 Swagger 同步的功能,确保你的 API 文档与代码中的修改保持最新。
调试模式
借助调试模式特性,可以在调试过程中实时修改 API 定义,支持在开发和测试代码时对 API 进行迭代。
动态值
向请求中注入真实的动态值,模拟实际场景,帮助识别数据变更处理中的潜在问题。
环境与服务
支持不同环境和服务的配置,允许开发者在开发、测试和生产环境之间切换。该功能为在各种条件下测试 API 提供了灵活性。
前后置操作
允许定义在发送 API 请求前后可以执行的脚本、断言、提取响应数据等操作。这些操作可以包括数据处理、错误处理或 API 响应处理等。
使用脚本
开发者可以编写和执行脚本,实现高级定制和自动化的 API 开发与测试任务。脚本可用于执行复杂操作、与外部系统交互,或增强 API 请求和响应的功能。
接口用例
Apifox 中的接口用例是针对特定 API 接口预定义的测试用例,用于简化创建、管理和执行 API 测试的过程,以及将其集成到自动化测试工作流中。
修改于 2025-02-20 02:13:26
上一页
接口唯一标识
下一页
生成请求
Built with