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. 最佳实践

最佳实践

在使用 Apifox 进行接口管理和 API 测试的过程中，无疑会遇到各种问题和挑战。为了帮助你高效地解决疑问并深入理解 Apifox 的强大功能，我们精心整理了一系列最佳实践，并将它们编纂成这份综合指南。这份合集是动态的——我们致力于持续地更新和丰富内容，以保证你随时能够获取最新的信息和技巧。
如果在这里没有找到你要的答案，你也可以访问我们的官方帮助文档，或者进入我们的用户群，联系我们的技术支持帮你解答。

入门教程#

《如何设计一份规范、完整、清晰的 API 接口文档》
《测试工程师如何高效使用 Apifox？》
《后端开发如何高效使用 Apifox？》
《Apifox 如何发送 json 格式的 post 请求》
《Apifox 中如何设置超时时间》
《Apifox 中 Query 和 Path 参数如何填写》
《接口请求 Body 中的参数，如何在 Apifox 中批量添加？》
《Apifox 如何导入和导出 cURL》
《将第三方平台的接口文档快速导入 Apifox》
《之前使用 Postman 来管理 API，如何迁移到 Apifox？》
《之前使用 Swagger 来管理 API，如何迁移到 Apifox？》
《如何使用 Apifox 的「默认响应模板」功能避免重复造轮子》
《Apifox 中如何将接口文档导出为 PDF、Word 等格式》
《Apifox 中如何将接口文档导出为 Markdown、Swagger、OpenAPI 等格式》

进阶教程#

《Apifox 中一个项目的不同接口如何对应不同的后台服务》
《Apifox 的可视化响应功能，让你的接口数据一目了然》
《如何使用 Apifox 校验响应数据是否符合预期》
《Apifox 中怎么获取当前时间戳作为接口的入参？图文教程》
《Apifox 中如何批量修改环境变量》
《Apifox 中如何上传/下载文件》
《Apifox 中上传文件（file）如何对路径实现参数化》
《Swagger 文件自动导入 Apifox 后出现目录重复的问题如何解决》
《Apifox 中的团队与项目权限设置介绍》
《Apifox 中如何将「消息通知」集成到第三方应用（企业微信、钉钉、飞书、Webhook、Jenkins）》
《如何在 Apifox 中调试 HTTP2》
《Apifox 中如何调试 GraphQL》

接口鉴权/加解密系列#

《Apifox 发请求时如何自动获取Cookie 和 token》
《如何用手动和自动两种方法更新 token》
《如何使用 Apifox 调试 OAuth 2.0 鉴权的接口：以微信登录为例》
《使用 Apifox 配置 OAuth 2.0 并直接获取访问令牌》
《带你玩转接口管理工具加解密》
《Apifox 中通过 CryptoJS 给请求参数进行 AES 加密》
《当响应数据经过编码或加密，如何在 Apifox 中处理？》

前置/后置操作系列#

《Apifox 中怎么获取当前请求接口的 URL》
《Apifox 中使用 JSONPath 提取接口响应的基本用法》
《Apifox 中提取接口响应数据的技巧》
《Apifox 中接口返回的图片验证码怎么显示？》
《Apifox 中如何对接口返回的时间戳进行转换？图文教程》
《如何在 Apifox 中调用其他语言（Java、PHP、Python、Go 等）》
《要在「前/后置操作」中获取当前接口的请求参数，怎么在 Apifox 中操作？》

Mock 系列#

《如何使用 Apifox 的 Mock 功能来模拟常见业务数据》
《Apifox 中如何拼接 Mock 函数》

数据库系列#

《Apifox 中操作数据库的常见场景》
《如何使用 Apifox 操作 MongoDB 数据库》

自动化测试系列#

《理论篇：如何高效开展 API 自动化测试》
《引用前置接口响应数据，让自动化测试编排更方便》
《Apifox 自动化测试中 ForEach 循环的使用》
《Form-Data 格式文件上传在 CICD 中的实现方式》
《如何将 Apifox 的自动化测试与 Jenkins 集成？》
《Apifox 中自动化测试的测试场景如何批量导入和导出》
《Apifox 「定时任务」操作指南，解锁自动化测试的新利器》
《Apifox「定时任务」进阶指南：监控、爬虫的自动化之旅》

gRPC 系列#

《一文读懂 gRPC 与 RPC，并优雅地掌握调试方式》

WebSocket 系列#

《如何使用 Apifox 调试 WebSocket API》

Dubbo 系列#

《Apifox 带你玩转 Dubbo 协议》
本文其它教程持续更新中……
修改于 2025-02-20 02:35:29
上一页
通过 MCP 使用 OpenAPI/Swagger文档
下一页
接口之间如何传递数据
Built with