1. 模块简介

进入【首页】——点击【数据源】,进入数据源界面
数据源管理主要是用来查外部接口,定义接口规范
图片.png

2. 添加数据源

点击添加按钮添加数据源配置,进行该数据源的简单介绍
图片.png
属性配置说明
类型:选择数据源类型,http数据源或数据库数据源
名称:为该数据源命名
数据源说明:可输入数据源的简单介绍或用途
BaseURL:点击输入通用地址前缀

2.1 添加具体接口

数据源基本信息填写完毕后,点击添加数据接口
图片.png
属性配置说明
标识:操作的唯一标识,必须为英文字母、数值或下划线。该标识在调用接口时使用。
名称:为该接口命名
参数:定义系统参数,点击填写参数名,选择参数类型,输入默认值

2.1.1 定义接口相关信息

图片.png
注意事项:

  • 接口路径 建议不要包含 HTTP 协议及域名,这部分建议在环境管理的前置URL里设置,接口调试时的 URL 会自动加上当前环境的前置URL。
  • 特殊情况需在接口路径要带上HTTP 协议及域名的,系统也能支持,但不建议这么做。接口调试时,系统如检测到接口路径是以http://或https://起始的,会自动忽略当前环境里前置 URL。
  • Apifox 中的 Path 参数是以大括号包裹起来表示,而非冒号起始表示。正确示例:/pets/{id},错误示例/pets/:id。
  • 接口路径 不可包含Query 参数(即 URL 中 ?后的参数),Query 参数在下方请求参数部分填写。

Params参数: 包含 Query 参数和 Path 参数两部分

  • Query 参数:即 URL 中 ?后的参数。
  • Path 参数:自动提取接口路径中大括号包裹起来的参数,如/pets/{id}中的的{id}即表示名为id的 Path 参数。

图片.png
Body参数
图片.png

  • none:无 body 参数。
  • form-data:即 Content-Type 为multipart/form-data。
  • x-www-form-urlencoded:即 Content-Type 为application/x-www-form-urlencoded。
  • raw:发送其他文本类数据时使用。

注意:GET方式的接口,body 参数只能设置为none。
Body 参数类型为json或xml时,需要设置数据结构,并且数据结构可以引用数据模型
接口发送请求的时候会根据Body 参数类型自动在请求Header加上对应的Content-Type,无需手动设置。
若需要手动设置Header中的Content-Type,则其值必须和Body 参数类型相匹配,否则系统会自动忽略掉手动设置的Content-Type。

  1. 示例:如 Body 参数类型为form-data,手动设置Content-Type的值为multipart/form-data; charset=GBK是有效的;但如果把值设置为application/json则会被系统忽略掉,因为和参数类型不匹配。
  2. Body 参数类型为raw时,手动设置Content-Type的值不受限制。

参数中使用环境变量
所有参数都可以使用变量,使用方式为双大括号包裹变量名,如{{my_variable}},表示引用名为my_variable的变量。
参数值使用变量时可以包含变量以外的字符串,如:参数值设置为prefix-{{my_variable}}-surfix,假设运行时变量my_variable的值为123,则实际请求时参数的值为prefix-123-surfix。
前置脚本: 前置脚本是在请求发送前执行的代码片段。如要在请求头中包含时间戳或在 URL 参数中发送随机的字母数字字符串等类似请求中非常适用。
图片.png
后置脚本: 后置脚本是在请求发送完成后执行的代码片段。主要用来断言请求返回的结果是否正确、将请求返回的结果数据写入环境变量等。
图片.png

2.1.2 运行

点击运行按钮并发送请求
图片.png