关于api:Apikit-自学日记发起文档测试HTTP

43次阅读

共计 3288 个字符,预计需要花费 9 分钟才能阅读完成。

HTTP

性能入口:API 治理利用 / 选中某个我的项目 / API 文档菜单 / 选中某一 API 文档 / 点击“测试”TAB

API 文档测试页,可对该 API 文档形容的接口进行疾速测试。API 文档测试页分为地址管制栏、申请控制区、返回展示区,以及测试辅助工具区共四个局部。

一、地址管制栏

测试页顶部是地址管制栏,接口的协定固定不可更改,但可调整接口申请形式和接口地址 URL。

1、接口测试 URL 调整

在本页面点击右上角的 切换环境,零碎会主动填入该环境的域名或 IP 到 URL 地址前缀。用户也能够间接在地址栏中填入域名或 IP 进行测试。

2、导入或存为测试用例

URL 编辑栏旁第一个按钮可实现疾速导入旧的测试用例或存为新的测试用例。

点击该按钮,能够抉择以后接口已有的测试用例一键导入进行测试,也能够把以后调试结束的申请数据保留为一个新的测试用例。

3、测试发送按钮

在测试用例疾速操作按钮右侧是以后测试的发送按钮,该按钮高亮显示,按钮色彩追随主题色。点击发送按钮后,会依据申请数据对该接口发动一次申请。发动后零碎会开始读秒,显示该测试已耗时间。

发送按钮可选两种测试模式:服务器测试和浏览器插件测试

若抉择 服务器测试,则测试运行资源为 eolink 零碎的近程服务器资源。在 Eolink 的 SaaS 产品上,因为多个团队共用一套资源,故会测试申请减少了限度。若该接口测试耗时已超过 10 秒,则主动终止该测试工作,并返回接口超时的信息。

若抉择 浏览器插件测试,则测试运行资源为用户本地机器。但应用该模式须要追随指引装置浏览器插件。而在 PC 客户端上,该插件自身已集成在客户端框架内,无需下载安装,间接切换应用即可。

4、cookie 管理工具

测试过程中会须要应用多个不同的 cookie,cookie 管理工具能够快捷的解决这个问题。用户能够点击测试页面右上角的 cookie 管理工具按钮,关上治理窗口。

在 cookie 治理窗口中,先增加对应的域名地址,而后可对该域名地址增加多个 cookie 值。当进行接口测试时,申请的是对应的域名地址,则零碎会主动把该域名地址下的所有 cookie 值附带在申请头部中。

二、申请控制区

API 文档中的内容均会主动同步到测试页的申请控制区中,故申请控制区与 API 文档编辑页的申请参数输入区基本一致。均有申请头部、申请体、Query 参数、REST 参数、权限校验、前置脚本、后置脚本。而 API 测试页会减少对测试的高级设置内容。

故申请控制区的基本操作,请查看《编辑 API 文档》中的“申请参数”章节。以下仅阐明测试时须要留神的内容。

1、Content-type
零碎会依据测试申请体的内容,主动判断申请头 Content-type 标签的值。并默认填入申请头的 Content-type 字段,其判断条件如下:

2、申请字段可选框
在申请体的 Form-data 格局、JSON 格局、XML 格局,以及 Query 参数和 REST 参数的字段列表中,每个字段前均有一个申请字段可选框。该可选框的选中状态追随文档中的字段是否必填的选项,即若字段设置为必填,则在测试中,默认勾选该字段须要申请。若字段设置为非必填,则在测试中默认不勾选该字段为申请字段。

测试页中勾选了的字段,发动测试申请时该字段才会存在,否则申请时不会带上该字段的任何信息。

3、结构器

结构器是测试时零碎提供的疾速生成申请数据的工具。个别用于疾速对数据进行加密和生成随机数值。可在申请参数中某个字段的右侧抉择结构器操作,通过结构器生成该字段的参数值。结构器由两种类型的操作组成:设置初始数据和多重操作。

3.1 初始数据

其中初始数据可选三种类型:自定义数据、动静生成数据和生成随机数值。

  • 自定义数据
  • 在输出任何数据作为初始值,自定义数据的初始值个别用于须要对某个固定值加密的场景。
  • 随机数
  • 用户可填写最大值数值和最小值数值,零碎会从该数值范畴内随机输入某个数值。
  • 动静生成数据
  • 零碎提供相似于 Mock 申请参数值的能力,内置了多种动态数据生成公式,根本揽括了大部分的实用场景,具体可参照下表:

3.2 多重操作

输出了初始值后,可对该初始值进行各种数据操作,且可对数据操作后已解决的数据再进行其余的数据操作,以满足多重数据操作,如多重加密等场景。

以后提供的数据操作形式如下表:

3.3 表达式和动态值

用户在进行结构器操作的同时,结构器弹窗底部会同步显示以后已设置数据操作步骤的动静公式,以及依据公式随机生成的动态值。数据操作步骤设置结束后,用户能够抉择把动静公式或以后随机动态值插入到测试申请的参数值中。

若抉择插入的是动静公式且初始数据为动态数据或随机数,则每次测试零碎均会依据公式的条件,随机生成合乎公式的参数值。个别每次测试生成的随机值均不一样。

若抉择插入的是动态值,则会把该值固定填入到对应的参数值字段内,每次测试申请时均申请同一个参数值。

4、测试设置

API 文档测试的高级设置有 6 项,用于配置测试的非凡规定。具体逻辑如下:

  • 测试服务
  • 下拉单选,默认选中应用 Eolink Apikit 近程服务器。可选应用浏览器插件进行测试。选中后零碎会主动保留,选中其余接口测试时会沿用最近选种的测试服务形式。
  • 主动追随申请重定向
  • 开关配置,默认开启。
  • 验证 SSL 证书
  • 开关配置,默认敞开。敞开后可不验证 SSL 证书,但仅针对服务器测试或客户端测试。若是浏览器测试,则该开关配置有效,均须要验证 SSL 证书。
  • 发送 Eolink Token 头部
  • 开关配置,默认开启。开启后申请头会减少 Eolink Token 信息,若敞开则不增加。
  • 发送 no-cache 头部
  • 开关配置,默认敞开。开启后申请头会主动减少一条以下参数信息:
  • cache-control:no-cache
  • 报文编码格局
  • 单选配置,默认选中 UTF-8,可选项有 UTF- 8 和 GBK。

三、返回展示区

测试页底部是测试返回信息展示区。其中蕴含工夫剖析、返回后果、返回头部、申请内容、申请头部、测试历史等模块。

1、工夫剖析
工夫剖析模块可查看该接口申请的每一步耗时状况。可不便的理解在哪个环节耗时较长或导致的接口异样。

2、返回后果
用于展现该接口申请的返回后果和返回具体内容。若接口申请胜利,返回 200 状态码,则会在该模块页顶部展现 200。并在底部显示该接口的返回具体信息。

若接口返回异样,则会在该模块页顶部展现异样的状态码,并在底部显示具体的异样信息。

3、返回头部
接口申请胜利后,除了会展现返回后果外,也会展现具体的返回头部。在该模块可查看返回头部的所有信息。

4、申请内容
无论申请是否胜利,均可在申请内容中查看理论发送的申请体内容。可用于判断申请内容是否发送正确。

5、申请头部
展现该次申请的申请头部信息,蕴含了残缺的申请头信息。如暗藏的 eo-token,user-agent 等均会失常展现。

6、测试历史

在 API 文档测试页对该接口进行的每一次测试均会被零碎保存起来,成为测试历史。

点击某行测试历史,零碎会主动填充该历史的所有数据到以后测试页中。蕴含过后的测试地址、申请内容以及返回后果。会用历史的数据笼罩以后的数据来进行历史测试状态的残缺复现。

用户可点击单行测试历史右侧的删除按钮,删除对应的测试历史数据。或点击顶部的清空测试历史按钮,清空所有的测试历史记录。

四、测试辅助工具

在测试过程中,Eolink 提供两种测试辅助工具:环境治理和 cookie 治理。另外还有评论和变更告诉管理工具,这里不赘述。

1、环境管理工具
测试页面右上角的快捷环境管理工具次要用于切换测试环境。可抉择利用级和我的项目级已创立好的环境进行测试。选中某个环境后,接口 URL 会主动补充该环境域名或 IP 作为前缀。

可点选仅展现以后账号创立的环境,不便在团队合作时疾速找到本人的测试环境。

点击环境管理工具上的小眼睛图标,能够查看以后的全局变量和环境变量状况。须要留神的是当全局变量和环境变量均有同一变量参数,则读取环境变量的变量值。即环境变量优先级大于全局变量。用户也能够在以后的变量预览表中对变量值进行编辑。

2、生成申请示例代码

在测试发送按钮右侧是生成代码按钮,该按钮是可一键依据以后测试页的申请数据生成多种支流编程语言的接口申请代码。不便用户在程序中复用该申请数据。

正文完
 0