在<事务设置>中添加并管理需要监控的API请求,如下图所示。

图片3.png

您能够直接导入脚本来添加API请求,也可手动添加和设置API请求。添加API请求后,可直接复制已添加的请求来创建新的请求。

通过导入脚本添加API请求

为快速创建多条API请求,点击<导入脚本>按钮,在打开的对话框中直接输入脚本内容并导入。导入成功后,监控宝根据导入的脚本自动创建对应的API请求。

点击<查看实例>按钮了解脚本样式,脚本支持postman和Jmeter格式。您可以直接使用postman中生成的脚本。

手动添加API请求

点击<添加请求>按钮,打开请求编辑页面,如下图所示。

图片4.png

根据实际需要设置各项内容,详细说明见下表。

配置类型

设置项

说明

基本信息

目标URL

选择请求方式并填写监控目标的URL,目前支持的请求方式包括:GET、POST、PUT、DELETE、HEAD和OPTIONS。

认证

点击 图片5.png 按钮添加身份认证信息,目前支持的认证方式包括:Basic Auth、OAuth1.0、OAuth2和Digest。

  • 选择Basic Auth和Digest认证时,需要填写用户名和密码,在访问API时使用。

  • 选择OAuth1.0和OAuth2认证时,需要在请求API时自动获取Access_Token和Refresh_Token,然后通过URL进行传递。

:设置正确的认证信息后,才能成功访问API,从而监控API请求。

URL参数

  • 设置的URL不包含参数时,点击<添加URL参数>按钮添加URL参数,定义需要传递的参数,包括参数名和对应的值。

  • 设置的URL中已经包含了参数时,直接点击<参数自动解析>按钮获取参数即可。

您也可以重新编辑或删除参数。

HTTP头

点击<添加HTTP头>按钮添加HTTP请求头,定义请求需要获取的内容,包括请求头及对应的值。

断言

断言

点击<添加断言>按钮添加断言,设置断言的位置、属性名、比较条件和目标值,从而检查API请求获取内容是否与预期内容相匹配。

  • 位置:目前支持的获取位置包括:Json Body、XML Body、Text Body(XPath)、Response Headers和状态码,例如选择“Json Body”。

  • 属性名:设置要检查的属性名,例如输入“id”。

  • 比较条件:设置目标值与获取内容的比较条件,包括为空、不为空、等于、不等于、包含、不包含、是数字、小于、小于等于、大于、大于等于、数值等于等条件,例如选择“等于”。

  • 目标值:设置判断获取内容是否正确的一个标准值。
    点击<自定义>按钮输入一个值;点击<变量>按钮可直接选择一个已定义的初始化变量作为目标值。初始化变量需要提前定义,参考<
    设置初始变量>部分。
    例如选择已定义的变量“$a”,则设置的断言的为:在JSON Body中,id的属性值等于变量“$a”的值,依次判断获取内容是否正确。

:添加断言后才能判断API请求的正确性,若匹配则正确性为“是”,否则为“否”。

变量

变量

变量可用来存储值,动态地提取HTTP响应数据,并在多个请求之间动态地传递数据和状态。

点击<提取变量值>按钮,设置获取位置、属性值提取表达式并选择初始化变量,则可动态提取属性值并赋给初始化变量。Text Body支持提取字符串,能够提取动态输出的数据。

关于初始变量设置,参考<设置初始变量>部分。

复制API请求

为避免重复设置,添加API请求后,您可点击<图片6.png>图标复制当前API请求作为一条新的API请求,点击<图片7.png>图标根据需要修改相应内容即可。

移动API请求

当添加多个API请求,如果需要调换请求的先后顺序,鼠标拖动目标请求拖向目标位置。

添加请求间隔

点击<添加请求间隔>,输入发送API请求的时间间隔,例如设置“10s”,则发送一次API请求后,等待10s发送第二次API请求。

测试API监控请求

添加API请求后,为保证正常监控,需检查是否能请求成功。点击<验证测试>按钮来测试请求并查看测试结果,如下图所示。

图片8.png

请求成功即可用,所有请求都成功时,监控项目(即整个业务流程)的状态为正常且可用,点击<展开->返回结果>查看请求的返回结果。

添加断言时才能测试请求的正确性,所有请求都正确时监控项目的正确性为“是”,点击<展开->变量与断言>查看断言详情。