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 时,了解如何发送不同类型的数据至关重要。Apifox 提供了一个用户友好的界面,帮助你构建并发送带有不同请求参数和请求体类型的 API 请求。

请求参数#

参数可以让你可以向服务器发送额外的信息。Apifox 支持两种主要的参数类型:查询参数 (Query params) 和路径参数 (Path params) 。

Query 参数#

Query 参数附加在 URL 末尾的问号 (?) 之后,并用与号 (&) 分隔。它们用于向服务器发送可选或附加的数据。在 Apifox 中,你可以轻松地为你的 API 请求添加和管理 Query 参数。
有两种方便的方法来为你的接口添加 Query 参数:
1.
直接在 URL 中: 你可以在地址栏中的 URL 末尾直接附加 Query 参数。例如:https://api.example.com/users?page=1&limit=10
2.
使用 Query 参数输入框: Apifox 提供了一个位于 URL 输入框下方的专用 Query 参数输入框。在这里,你可以使用一个用户友好的界面来添加、编辑和删除 Query 参数。你在这一部分添加的参数将自动附加到请求 URL 中。
Query 参数中的等号
在某些特殊情况下,Query 参数可能不会以键值对的形式出现。例如,请求 URL 可能是这样的:
https://api.example.com/users?available
在这种情况下,available 可以作为一个没有值的参数。当值为空时,Apifox 会自动省略键和值之间的等号。
如果不想省略这个等号,你可以手动选择 “添加等号”。
image.png

Path 参数#

Path 参数是 URL 路径的一部分,通常用来标识特定的资源。它们在 URL 中用占位符表示,通常放在大括号 {} 中。
示例:
https://api.example.com/users/{userId}
在 Apifox 中,你可以像上面显示的那样在 URL 中定义 Path 参数,它们会在 URL 输入框下面的 Path 参数中出现。你可以在 Path 参数中填写参数的值,当请求发出时,{param} 将被替换为实际的值。这个功能特别适合测试那些在 URL 中使用资源标识符的 RESTful API。
image.png
如果需要在路径参数中使用变量,推荐的方式是在 URL 中先使用 {param},然后在参数值中使用 {{variable}}。

参数编码与解码#

选择参数文本后右键点击,可以对参数进行 EncodeURIComponent 编码或 DecodeURIComponent 解码,也可以将其存入变量。
了解更多 URL 参数编码信息。

请求体#

请求体(Body)用于在 POST、PUT 或 PATCH 请求中传递数据到服务器。Apifox 支持多种请求体数据格式。

form-data#

form-data 是一种发送键值对的方式,类似于提交 HTML 表单。这种格式特别适用于需要上传文件的同时发送其他数据的情况。
image.png
form-data 类型的请求 Body 将在请求中显示为 multipart/form-data。对于请求 Body 中的每个参数,你可以选择其类型,如字符串、整数等。
如果需要在 form-data 中发送 JSON,你需要将参数类型设置为 string,然后在字段的参数值中填入 JSON。
如果需要在请求中发送文件,请选择类型为文件,然后点击 “Upload” 并选择本地文件。
Apifox 仅在请求中发送文件,但不会将文件保存在云端。因此,在团队协作期间,其他人可以看到这个请求但不能直接发送这个文件。你需要通过其他方式将文件传输给同事,以便他们能够发送。

x-www-form-urlencoded#

这种格式类似于 Query 参数,但发送在请求 Body 中。它常用于提交不需要上传文件的简单表单。在 Apifox 中,你可以轻松地使用键值对添加和编辑 x-www-form-urlencoded 数据。

JSON#

JSON 是 API 请求和响应中广泛使用的数据格式。Apifox 提供了一个具备语法高亮和验证功能的 JSON 编辑器,简化了 API 请求中 JSON 请求体的构建和编辑过程。
如果你想在 JSON 中添加注释,可以在“设置 -> 常规设置 -> 功能设置 -> 高级设置”中启用“兼容带注释的 JSON”。发送 JSON 时,这些注释将自动移除。
CleanShot 2024-10-12 at 16.01.15@2x.png

XML#

XML(可扩展标记语言)是另一种在 API 通信中常用的格式。Apifox 支持 XML 载荷,允许你以 XML 格式发送结构化的数据。

raw#

raw 选项允许在请求体 (Body) 中发送任何自定义数据格式。这对于处理一些期望特定数据结构或格式的 API 非常有用,尤其是当这些结构或格式不属于其他选项覆盖的范围时。

binary#

此选项允许发送二进制数据,对上传文件或与需要二进制数据的 API 交互特别有用。Apifox 支持选择并发送二进制文件作为 API 请求的一部分。

GraphQL#

对于基于 GraphQL 的 API,Apifox 提供了一个专用的 GraphQL 编辑器。这个功能允许你构建并发送 GraphQL 查询 (Query) 和变量 (Variables) ,并支持语法高亮和自动补全。

Msgpack#

MessagePack 是一种比 JSON 更紧凑且更快速的二进制序列化格式。Apifox 支持发送 MessagePack 数据,这对于需要优化性能和减少数据传输的 API 非常有利。
修改于 2025-04-24 06:00:25
上一页
请求 URL 与方法
下一页
请求头
Built with