教程:在 Apifox 中将消息通知集成到钉钉、飞书等应用

Apifox 支持将「消息通知」集成到第三方应用平台,包括企业微信、钉钉、飞书、Webhook 和 Jenkins。具体可在项目的【项目设置 -> 通知设置 -> 外部通知】里新建一个通知事件,然后在弹出的界面中配置即可。

图片

在配置界面可以选择需要的触发事件,例如接口变更、自动化测试、文档变更等。当这些事件在项目内被触发时,通知会实时发送到配置的第三方平台,例如飞书:

图片

需要注意的是,事件的配置需要项目管理员权限,其它权限的成员无法进行此操作。目前,支持的「触发事件」如下:

图片

下面我们就介绍一下怎么将「消息通知」与这几个平台进行关联,在此之前,请确保 Apifox 已更新到最新版

企业微信

要将「消息通知」集成到企业微信,需要在 企业微信 的群聊机器人中获取 Webhook URL,然后将这个 Webhook 地址配置到 Apifox 中即可,下面为详细步骤。

首先打开企业微信,选择群聊,然后在群聊中选择「添加群机器人」。

图片

如果在添加机器人时提示「还没有已发布的机器人」,那说明没有权限,或者没有在管理后台开启,这个时候需要到企业微信后台配置,地址为:企业微信

图片

如果你是企业微信的企业管理员,也可点击「管理企业」进入企业微信后台 (不同版本可能不一样) 。

图片

然后在「应用管理」下方,选择「机器人」这个应用,把它开启并添加白名单。

图片

回到企业微信群聊,添加一个群机器人,然后将生成的 Webhook 地址复制下来,以粘贴到 Apifox 中。

image.png

打开 Apifox,在项目中依次点击【项目设置 -> 通知设置 -> 外部通知】选项,然后在这里新建一个通知事件。

图片

在弹出的配置界面,你可以选择一些「触发事件」,比如接口变更、文档变更、自动化测试、迭代分支变更等事件,并将企业微信生成的 Webhook 地址粘贴到「服务 URL」,配置完毕后保存即可。

图片

现在,你可以在项目中做一些操作,以测试是否成功。当选择的事件被触发时,将在企业微信群聊中收到通知,比如,某个接口进行了修改,收到了相关的消息提示。

图片

钉钉

要将「消息通知」集成到 钉钉,需要在钉钉的群聊机器人中获取 Webhook URL,然后将这个 Webhook 地址配置到 Apifox 中即可,下面为详细步骤。

首先打开钉钉,选择一个内部群聊,然后依次点击【群设置->机器人->添加机器人】选项。

图片

在弹出的界面中,选择「自定义」机器人。

图片

在配置信息中,需要对其进行安全设置,比如「加签」,这里的密钥对应 Apifox 中的「加密密钥」,设置完毕后,保存即可。

图片

这时,就会生成 Webhook 地址,复制下来,以粘贴到 Apfiox 中。

图片

打开 Apifox,在项目中依次点击【项目设置 -> 通知设置 -> 外部通知】选项,然后在这里新建一个通知事件。

图片

在弹出的配置界面,你可以选择一些「触发事件」,比如接口变更、文档变更、自动化测试、迭代分支变更等事件,并将钉钉生成的 Webhook 地址粘贴到「服务 URL」,如果有加密密钥,也一并填入,配置完毕后保存即可。

图片

现在,你可以在项目中做一些操作,以测试是否成功。当选择的事件被触发时,将在钉钉群聊中收到通知,比如,执行了接口的自动化测试,便收到了相关的消息通知。

图片

飞书

要将「消息通知」集成到 飞书,需要在飞书的群聊机器人中获取 Webhook URL,然后将这个 Webhook 地址配置到 Apifox 中即可,下面为详细步骤。

首先打开飞书,选择一个群聊,然后依次点击【群设置 -> 群机器人 -> 添加机器人】选项。

图片

在弹出的界面中选择「自定义机器人」。

图片

然后配置相关信息后会生成一个 Webhook 地址,将该地址复制下来,以粘贴到 Apfiox 中。此外,还需要进行安全设置,这里可以增设一个「签名校验」,如下图所示:

图片

打开 Apifox,在项目中依次点击【项目设置 -> 通知设置 -> 外部通知】选项,然后在这里新建一个通知事件。

图片

在弹出的配置界面,你可以选择一些「触发事件」,比如接口变更、文档变更、自动化测试、迭代分支变更等事件,并将飞书生成的 Webhook 地址粘贴到「服务 URL」,如果有加密密钥,也一并填入,配置完毕后保存即可。

图片

现在,你可以在项目中做一些操作,以测试是否成功。当选择的事件被触发时,将在飞书群聊中收到通知,比如,合并了一个迭代分支,便收到了相关的消息通知。

图片

Webhook

除了将「消息通知」集成到第三方应用,还可以集成到自己搭建的 HTTP 服务,只需在服务端指定一个 POST 接口来接收参数即可。 

比如服务端有一个名为 POST http://127.0.0.1:8080/webhook 的 API 可接收入参,你可以将这个路径配置到 Apifox 中,如果有加密密钥,也一并填入,配置完毕后保存即可。

图片

现在,你可以在 Apifox 项目中做一些操作,以测试是否成功。当选择的事件被触发时,Apifox 将发送类似以下的信息到指定的服务端 URL :

 

{ "event": "API_UPDATED", "title": "接口修改提醒", "content": "所在团队:Ring 共享项目 \n所在项目:宠物商店 \n迭代分支名称:main \n接口名称:获取顾客信息 \n接口路径:GET /user/208010884 \n状态:开发中 \n责任人:-- \n \n修改者:Ring \n修改时间:2024-05-13 23:40:36"}

服务端拿到这些信息后,可以将其美化展示。

image.png

Jenkins

要将通知事件集成到 Jenkins 服务,可以通过 Jenkins 的 Generic Webhook Trigger 插件来获取 Webhook URL,然后将该 Webhook 地址配置到 Apifox 中即可。当 Apifox 中选择的接口变更、文档变更等事件被触发时,将会自动触发 Jenkins 发起一次构建行为,你可以在构建历史记录中查看消息,下面为详细步骤。

首先打开 Jenkins 服务,然后在插件市场搜索「Generic Webhook Trigger」插件,安装即可,安装完毕需要重启 Jenkins 服务。

图片

然后在 Jenkins 中选择一个项目,在项目中依次点击【Configure -> Build Triggers - >Generic Webhook Trigger】选项 (注意不同版本界面可能不一样) ,这里会生成一个 Webhook 地址,复制下来粘贴到 Apifox 中即可,注意需要将  JENKINS_URL 替换为你的公网 IP 或域名。

图片

此外,为了安全,还可以配置 Token,这里的 Token 对应 Apifox 里的「签名令牌」,相关信息配置完毕后,保存即可。

图片

打开 Apifox,在项目中依次点击【项目设置 -> 通知设置 -> 外部通知】选项,然后在这里新建一个通知事件。

图片

在弹出的配置界面,你可以选择一些「触发事件」,比如接口变更、文档变更、自动化测试、迭代分支变更等事件,并将 Jenkins 服务生成的 Webhook 地址粘贴到「服务 URL」,如果配置有 Token,也一填入到「签名令牌」中,配置完毕后保存即可。

图片

现在,你可以在 Apifox 项目中做一些操作,以测试是否成功。当选择的事件被触发时,将自动触发 Jenkins 发起一次构建行为,可在构建历史记录中查看消息:

图片

Apifox 支持将「消息通知」集成到第三方应用平台,包括企业微信、钉钉、飞书、Webhook 和 Jenkins。管理员可以在项目的【项目设置 -> 通知设置 -> 外部通知】中配置通知事件,并选择需要的触发事件,例如接口变更、数据模型变更、文档变更等,当这些事件被触发时,通知会实时发送到配置的第三方平台。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/632082.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

如何在WordPress中启用两因素身份验证?

在WordPress中启用两因素身份验证方法:安装和激活WordFence安全性、启用两因素验证。 使用您可以从任何位置登录的任何门户,建议启用两个因素身份验证以增加帐户的安全性。 这样,即使有人可以正确猜测你的密码,它们仍然需要获得2…

诸葛智能携手五大银行,以数据驱动的营销中台带来可预见增长

对于银行来说,客户是赖以生存的基础,也是保持活力的关键。尤其是大数据、人工智能等新兴技术的推动下,通过数据赋能产品升级和服务创新,深挖客户潜能,更是助推银行快步迈入高质量发展的新阶段。 在银行加速拥抱新质生…

32位处理的寻址方式

32位处理器兼容16位处理器的寻址方式,可以运行传统的16位代码。但是由于32位的处理器都拥有32位的寄存器和算数逻辑部件,而且同内存芯片之间的数据通路至少是32位的,因此,所有需要从寄存器或者内存地址处取得操作数的指令都被扩充…

Python专题:八、为整数增加小数点

1、题目 虽说很多人讨厌小数点,但是有时候小数点是必不可少的一项,请你使用强制类型转换为输入的整数增加小数点,并输出改变类型后的变量类型。 2、代码 import sysa float(int(input())) print(f"(a:.lf)",type(a),sep"\…

RTMP低延迟推流

人总是需要压力才能进步, 最近有个项目, 需要我在RK3568上, 推流到公网, 最大程度的降低延迟. 废话不多说, 先直接看效果: 数据经过WiFi发送到Inenter的SRS服务器, 再通过网页拉流的. 因为是打金任务, 所以逼了自己一把, 把RTMP推流好好捋一遍. 先说说任务目标, 首先是MPP编码…

什么是检索增强生成(Retrieval Augmented Generation)?RAG 架构如何实现?

检索增强生成(Retrieval Augmented Generation)时代 在不断发展的生成人工智能世界中,检索增强生成 (RAG) 标志着一项重大进步,它将检索模型的准确性与生成模型的创造性相结合,达到了准确&创新的更高层级。 这种…

vue嵌套路由

一、嵌套 children配置 1.父类路由 mymusic 2.子类路由 musicson 1.创建MusicSon组件 <template><div><p>从前和后来</p><p>唯一</p><p>运气来的似有若无</p></div> </template><script>export defaul…

关于电源3(整流滤波电路)

整流滤波电路 框图 一共有四种整流电路 以下是自己参考别人的文章https://blog.csdn.net/zhuguanlin121/article/details/130653498?ops_request_misc%257B%2522request%255Fid%2522%253A%2522171582622316800215096518%2522%252C%2522scm%2522%253A%252220140713.130102334…

【全开源】云界旅游微信小程序(源码搭建/上线/运营/售后/维护更新)

开启您的云端旅行新体验 一、引言 在快节奏的现代生活中&#xff0c;旅行成为了人们放松身心、探索世界的重要方式。让您的旅行更加便捷、高效&#xff0c;打造了云界旅游小程序&#xff0c;带您领略云端旅行的无限魅力。 二、小程序功能概览 云界旅游小程序集成了丰富的旅游…

SIP-7041 20W SIP广播网络有源音箱 校园广播20W木质SIP音箱

SIP-7041 20W SIP广播网络有源音箱 校园广播20W木质SIP音箱 一、描述 SIP-7041 20W SIP广播网络有源音箱 支持标准SIP协议 SIP-7041是我司的一款壁挂式网络有源音箱&#xff0c;具有10/100M以太网接口&#xff0c;可将网络音源通过自带的功放和喇叭输出播放&#xff0c;可达到…

二三维战场仿真系统

收费工具&#xff0c;白嫖党勿扰 收费金额1万元 1 概述 给某个公司做了一个战场仿真系统&#xff0c;该公司给了5W的辛苦费。现在把相关功能部分提取出来&#xff0c;给需要的同学。 2 功能说明 战场仿真系统&#xff0c;分为三个部分&#xff1a; 服务器&#xff0c;用来发…

澳鹏Appen入选大模型产业链基础层图谱及案例研究

近日&#xff0c;由亿欧、上海市人工智能行业协会&#xff08;SAIA&#xff09;主办的2024全球开发者大会“百模大战”商业发展讲坛成功举办。作为全球开发者大会的平行技术论坛之一&#xff0c;本场论坛聚焦大模型产业&#xff0c;分析大模型赛道的竞争格局&#xff0c;洞悉大…

visual studio snippet常用注释片段

Visual Studio 2022 添加自定义代码片段_vs2022 代码片段-CSDN博客 dclass.snippet: <?xml version"1.0" encoding"utf-8"?> <CodeSnippets xmlns"http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> …

Hello, GPT-4o!

2024年5月13日&#xff0c;OpenAI 在官网正式发布了最新的旗舰模型 GPT-4o 它是一个 多模态模型&#xff0c;可以实时推理音频、视频和文本。 * 发布会完整版视频回顾&#xff1a;https://www.youtube.com/watch?vDQacCB9tDaw GPT-4o&#xff08;“o”代表“omni”&#xff0c…

haddoop三大核心组件

hadoop三大核心组件分别是hdfs、mapreduce和yarn。 1、hdfs&#xff1a;即分布式文件系统&#xff0c;用于存储hadoop集群中的大量数据。具有高容错性&#xff0c;可跨多个数据节点存储数据&#xff0c;并提供高吞吐量的数据访问&#xff1b; 2、mapreduce&#xff1a;用于大…

Python代码:一、HelloWorld

1、题目&#xff1a; 将字符串 Hello World! 存储到变量str中&#xff0c;再使用print语句将其打印出来。 2、代码 import sys str Hello World ! print(str)3、在sublime运行的结果

IT行业的现状与未来发展趋势:重塑生活与工作的无限可能

随着科技的飞速发展&#xff0c;IT行业已经逐渐从幕后走到台前&#xff0c;成为推动全球经济和社会发展的核心动力。从云计算的普及、大数据的崛起&#xff0c;到人工智能的爆发&#xff0c;再到物联网、5G通信和区块链技术的日新月异&#xff0c;这些技术不仅正在深刻改变着我…

2024年抖店保证金交多少?保证金常见问题解答,一文解决你所有疑惑

大家好&#xff0c;我是电商花花 新手如果想要开抖音小店&#xff0c;有一个大坑是必须要避开的。 就是我们店铺开通之后&#xff0c;我们一定要交保证金&#xff0c;如果不交&#xff0c;那就是0元开店。 很多新手听别人说做抖音小店可以0元开店&#xff0c;不用缴纳保证金就…

案例 | 澳鹏自动驾驶标注方案入选虎嗅智库行业报告

随着自动驾驶技术发展及方案演进&#xff0c;市场对于数据标注的数量和质量的需求都呈现指数级增长。传统的手工标注已不能满足标注需求&#xff0c;自动标注伴随大模型的发展应运而生。 在这一背景下&#xff0c;虎嗅智库发布《自动驾驶数据标注技术落地洞察》&#xff0c;并…

Nginx part3 创建一个https的网站

目录 HTTPS 公钥和密钥 加密解密方式&#xff1a; https搭建步骤 强调一下 1、准备环境 2、配置文件 3、制作证书 4、进行设置 HTTPS 啥是https&#xff0c;根据百度&#xff1a;HTTPS &#xff08;全称&#xff1a;Hypertext Transfer Protocol Secure&#xff09;&a…