「Eolink Apikit 」如何快速创建有效的API监控任务?

API 小达人
• 阅读 163

API 监控能够确保 API 的稳定性。如果一个 API 出现故障或崩溃,它可能会导致整个应用程序无法正常工作。这对用户和业务来说可能是灾难性的。通过监控 API,开发团队可以及时发现问题并采取措施来修复它们,从而降低应用程序中断的风险。

作为开发人员,了解API生命周期中的每一个步骤可以帮助改善设计流程以及后续的流程,监控工具可以深入了解 API 的行为,监控 API 有助于:

  1. 问题识别;
  2. 问题修复;
  3. 功能分析;
  4. 新版本的迭代。

在 API 管理中,查看 API 异常监控的监控报告,在 Eolink Apiki 中也是常用的功能,通常你可以在流程综合报告页中看到当前流程在选定时间段内的整体监控情况。


1、手动创建监控 API

Eolinker API 网络监控平台支持从 Eolinker API Management(API管理产品)中导入API信息,或者手动创建监控API。

进入API监控页面,点击 添加API 按钮,会直接进入API监控编辑页面。你可以在编辑页中设置API监控的名称、请求地址、请求信息、校验规则等信息。

「Eolink Apikit 」如何快速创建有效的API监控任务?

进入API监控编辑页后,你可以设置API的基本信息、请求信息、校验规则等内容。

API 监控基础信息

API监控的基础信息包括:

  1. API请求地址
  2. API分组、名称
  3. API监控的项目环境
  4. API监控节点:系统会在选中的监控节点区域发起API监控请求
  5. 监控频率:系统会在选中的监控节点中按照设置的频率对API发起监控请求
  6. 超时限制:当API的响应时间超出设定的限制时间时,系统将会自动中断该次监控请求,并且报请求超时异常。

「Eolink Apikit 」如何快速创建有效的API监控任务?

请求头部

你可以输入或导入请求头部。批量导入的数据格式为 key : value ,一行一条 header 信息,如:

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

「Eolink Apikit 」如何快速创建有效的API监控任务?

请求体

请求体支持以下类型:Form-data(表单)、JSON、XML、Raw(自定义文本类型数据)。

Query 参数

Query参数指的是地址栏中跟在问号 ? 后面的参数,如以下地址中的 user_name 参数:

shop/query?shop_id=001

批量导入的数据格式为 ?key=value ,通过 & 分隔多个参数,如:

api.eolinker.com/user/login?user_name=jackliu&user_password=hello

「Eolink Apikit 」如何快速创建有效的API监控任务?

REST 参数

REST参数指的是地址栏被斜杠 / 分隔的参数,如以下地址中的 user_nameuser_password 参数。

/user/login/{user_name}/{user_password}

注意,只需要在URL中使用 {} 将REST参数括起来,下方的请求参数名中不需要使用 {}

「Eolink Apikit 」如何快速创建有效的API监控任务?

权限校验

如果访问API时需要先进行身份验证,可以在权限校验处填写校验的信息。

「Eolink Apikit 」如何快速创建有效的API监控任务?


2、从接口文档导入 API

如果你已经使用了 Eolinker API Management(API研发管理) 产品,你可以在创建监控接口的时候直接导入API Management 的API文档信息。

进入API监控页面,点击 添加API按钮旁的下拉菜单按钮,在菜单中选择 从API管理导入

「Eolink Apikit 」如何快速创建有效的API监控任务?

在弹窗中选择要导入的API并点击确定之后,会进入API监控信息编辑页面,在这里可以编辑每个导入的API的信息,一般来说你只需要补充API的请求参数值以及校验规则即可。

「Eolink Apikit 」如何快速创建有效的API监控任务?

「Eolink Apikit 」如何快速创建有效的API监控任务?

进入API监控编辑页后,你可以设置API的基本信息、请求信息、校验规则等内容。


3、开启监控

创建好API之后,在操作栏点击 更多 的按钮,在下拉菜单中选择 开启监控

「Eolink Apikit 」如何快速创建有效的API监控任务?

也可以在顶部点击 批量操作 按钮来对API做批量开启监控:

「Eolink Apikit 」如何快速创建有效的API监控任务?

「Eolink Apikit 」如何快速创建有效的API监控任务?

前置脚本和后置脚本

API脚本分为 API前置脚本API后置脚本 两种,分别对应API 请求前返回数据后的两个阶段。你可以通过编写Javascript代码,在API前置脚本中改变请求参数,或者是在API后置脚本中改变返回结果。

API脚本功能常用于以下几种情况:

  • API请求时对Body进行整体签名加密,常用于银行等系统测试中
  • API返回结果后对Body进行解密,常用于反爬虫系统的测试中
  • 发起的API请求会依次经过以下流程。其中如果你没有编写相应的API脚本,则会略过API脚本阶段。

「Eolink Apikit 」如何快速创建有效的API监控任务?

「Eolink Apikit 」如何快速创建有效的API监控任务?

返回结果校验

校验返回头部

返回头部支持以下校验选项:

校验方式 描述
存在性校验 判断是否存在该字段,如不存在则提示测试失败
值校验 判断返回内容与预设值是否相等,如不相等则提示测试失败

「Eolink Apikit 」如何快速创建有效的API监控任务?

校验返回结果

API测试用例支持5种校验方式:

校验方式 描述
不校验 无论返回结果是什么,均认为测试通过
校验状态码 判断响应头部中的HTTP Status Code
校验JSON 判断响应结果的JSON结构和参数值,可以判断对象、数组、字段等信息
校验XML 判断响应结果的XML结构和参数值,可以判断对象、数组、字段等信息
完全匹配 判断响应结果是否等于预期结果
正则匹配 通过正则表达式去匹配响应结果,如果匹配的结果集不为空,则认为测试通过

「Eolink Apikit 」如何快速创建有效的API监控任务?

存在性校验

当我们需要判断返回的头部/返回结果中的某个字段是否存在时,可以设置存在性校验来进行判断。

存在性校验 说明
是(默认) 判断是否存在该字段,如不存在则提示测试失败
不判断是否存在该字段

类型校验

设置对参数的类型进行校验,返回结果的参数类型必须要等于预设的参数类型,否则提示测试失败。

内容校验

设置对字段值的判断条件,不同类型的字段可能会有不同的判断条件。

校验规则 符号 说明
不校验 [] 不校验返回内容,任何值均判断为正确
值-等于 [value = ] 返回结果的 值 必须要 等于 预期结果,否则提示测试失败
值-不等于 [value != ] 返回结果的 值 必须要 不等于 预期结果,否则提示测试失败
值-大于 [value > ] 返回结果的 值 必须要 大于 预期结果,否则提示测试失败
值-小于 [value < ] 返回结果的 值 必须要 小于 预期结果,否则提示测试失败
值-包含 [include = ] 返回结果的 值 必须要 包含 预期结果,否则提示测试失败。比如预期结果为“hello”,实际返回结果为“hello world”,则测试结果正确。
值-不等于 [value != ] 返回结果的 值 必须要 不等于 预期结果,否则提示测试失败
正则 [Reg = ] 返回结果的 值 必须要 不等于 预期结果,否则提示测试失败
长度-等于 [length = ] 返回结果的 长度 必须要 等于 预期结果,否则提示测试失败
长度-不等于 [length != ] 返回结果的 长度 必须要 不等于 预期结果,否则提示测试失败
长度-大于 [length > ] 返回结果的 长度 必须要 大于 预期结果,否则提示测试失败
长度-小于 [length < ] 返回结果的 长度 必须要 小于 预期结果,否则提示测试失败

循环校验

对于数组类型(Array[])的返回参数,系统提供了 校验数组内元素 的选项,开启该选项之后,系统会对数组内的所有元素进行校验,否则仅校验数组内的第一个元素。

例如:

有如下JSON数组,当 demo_array 字段(红色部分)是一个数组类型时,开启校验数组内元素后会对demo_array下一级的字段(蓝色部分)进行整体的循环校验。

以下两张图的红色以及蓝色部分一一对应。

「Eolink Apikit 」如何快速创建有效的API监控任务?

「Eolink Apikit 」如何快速创建有效的API监控任务?

高级设置

重定向

可以设置是否跟随请求的重定向(HTTP 状态码为301、302)

「Eolink Apikit 」如何快速创建有效的API监控任务?

验证SSL证书

可以设置是否校验SSL证书

「Eolink Apikit 」如何快速创建有效的API监控任务?

发送Eolinker Token头部

可以设置是否发送Eolinker Token头部,Eolinker Token用于标识请求发送自Eolinker平台

「Eolink Apikit 」如何快速创建有效的API监控任务?

发送no-chche头部

可以设置是否发送 no-cache 头部,用于更新缓存数据

「Eolink Apikit 」如何快速创建有效的API监控任务?


Eolink Apikit 让开发人员和操作团队都可以轻松地监控他们所依赖的 API 的状态和行为。使 DevOps 团队能够连续监控异常情况,并使用可操作的上下文数据发送针对性的警报,以便快速解决出现的问题。了解更多关于Eolink Apikit 的 API 监控功能,请访问:www.eolinker.com

点赞
收藏
评论区
推荐文章
DevOpSec DevOpSec
3年前
运维,关于监控的那些事,你有必要了解一下
作者|乔克来源|运维开发故事监控是整个运维以及产品整个生命周期最重要的一环,它旨在事前能够及时预警发现故障,事中能够结合监控数据定位问题,事后能够提供数据用于分析问题。一、监控的目的监控贯穿应用的整个生命周期。即从程序设计、开发、部署、下线。其主要的服务对象有:技术业务技术通过监控系统可以了解技术的环
Wesley13 Wesley13
2年前
API管理工具的选择
近几年出现一个新兴的市场,旨在帮助负责管理生产中的分布式API集合的IT部门。这个市场正在迅速成熟,并且有很多功能,可以帮助增强API管理,监控,报告,分析等等。这个市场里流行的API管理工具包括:swagger、postman、eolinker等。这些工具,或者说这些平台,不仅提供API文档管理功能,还包括API在线测试,在确保api易于管理的同时,
Stella981 Stella981
2年前
Serverless 实战:通过 Serverless 架构实现监控告警
在实际生产中,我们经常需要做一些监控脚本来监控网站服务或者API服务是否可用。传统的方法是使用网站监控平台(例如DNSPod监控、360网站服务监控,以及阿里云监控等),它们的原理是通过用户自己设置要监控的服务地址和监测的时间阈值,由监控平台定期发起请求对网站或服务的可用性进行判断。这些方法很大众化,通用性很强,但也不是所有场景都适合。例如,如
API 小达人 API 小达人
5个月前
Eolink Apikit 如何对所有 API 异常请求实时监控 ?
API监控适合业务在互联网上,并且用户来自多个不同的地区,且对API的要求较高的场合,用于解决以下的问题:1.发现由于网络中断或者是API响应异常等导致的服务不可用;2.及时对异常的API进行告警;3.记录监控的日志,方便排查。EolinkApikit除了提供API的管理和自动化测试等功能,还提供API监控服务,可以为API设置定时拨测,并且支持多节点监控,可以从多个不同的地区节点来模拟用户的请求进行监控。
API 小达人 API 小达人
5个月前
开发常用的 3种 API 监控报告- Eolink Apikit
API监控报告是一种监测API异常的工具。在API管理中,查看API异常监控的监控报告,是EolinkApikit常用的功能。EolinkApikit的监控报告有3种:单接口监控报告、流程监控报告、项目监控报告
API 小达人 API 小达人
5个月前
实用干货丨Eolink Apikit 配置和告警规则的各种用法
API在运行过程中可能会遇到各种异常情况,如响应时间过长、调用频率过高、请求参数错误等,这些异常会对系统的稳定性和性能产生严重影响。因此,对API进行异常监控和告警是非常必要的。本文将介绍EolinkApikit中使用的告警规则,帮助开发者和运维人员更好地监控和管理API。
API 小达人 API 小达人
5个月前
流程测试用例的详细指南|Eolink Apikit 接口自动化测试
流程测试用例是为验证特定业务流程而设计和编写的测试案例,专注于检查系统或应用程序在执行某一业务流程时的正确性、稳定性和可靠性。一个业务流程可能涉及多个步骤、多个用户交互和多个系统组件的协作,流程测试用例有助于确保整个流程在各种情况下都能正常运行。在API自动化测试中,所有的测试用例都是以项目维度来进行管理,一个自动化测试项目可以从多个API文档项目中引用API信息来创建API测试用例。
小万哥 小万哥
4个月前
API 参考与帮助内容:一站式开发与使用者支援
API文档API文档是旨在了解API详细信息的综合指南。通常,它们包括端点、请求示例、响应类别和示例以及错误代码等信息。API文档可帮助开发人员了解API端点的具体细节,并了解如何将API成功集成到他们的软件中。文档生成工具API文档生成工具是直接从源代码
API 小达人 API 小达人
9个月前
改变数字经济的 10 大 API 趋势
根据谷歌2021年API经济状况报告,“公司报告称他们2021年主要优先事项包括关注API安全与治理(50%)、API增长和管理(41%)、投资建立开发者社区(38%)、通过API货币化产生收入(31%),使更多服务和数据公开可用(31%),以及增加对API操作和监控的投资(20%)”
API 小达人 API 小达人
7个月前
【接口自动化测试】Eolink Apikit 如何生成与导出接口文档?
在API研发管理产品中,几乎所有的协作工作都是围绕着API文档进行的。采用文档驱动的协作模式会比先开发、后维护文档的方式更好,团队协作效率和产品质量都能得到提高。基于文档来进行工作,使用文档驱动方式可以降低大量无意义的沟通成本。创建了API文档之后,可以随时查看API的改动情况、根据API文档发起API测试、编写API测试用例、使用MockAPI等。在EolinkApikit系统中管理的API文档,可以详细的看到API的描述信息、变更历史、测试用例、MockAPI等内容。