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

news2025/1/20 5:12:33

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。管理员可以在项目的【项目设置 -> 通知设置 -> 外部通知】中配置通知事件,并选择需要的触发事件,例如接口变更、数据模型变更、文档变更等,当这些事件被触发时,通知会实时发送到配置的第三方平台。

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

机器学习-SVM预测

本文使用机器学习SVM对数据进行预测。仅供参考 1、数据 1.1 训练数据集: medol.xlsx文件示例 otv3015-1.9153622093018-1.9634097763021-1.7620284083024-1.789477583 1.2 预测数据集 test.xlsx文件示例 ot35163519 2、模型训练 train.py import pandas as …

国内常用的项目管理软件有哪些?六大企业级项目管理软件大盘点

一、 奥博思 PowerProject 项目管理软件 官方网址:http://www.powerproject.com.cn 北京奥博思软件技术有限公司自成立以来,一直专注于企业级项目管理软件的开发及解决方案,致力于为各类企业(制造业、IT交付、金融、汽车及汽车零…

【工具】macOS、window11访问limux共享目录/共享磁盘,samba服务安装使用

一、samba服务安装 Samba是一个免费的开源软件实现,使得非Windows操作系统能够与Windows系统进行文件和打印服务共享。它实现了SMB/CIFS协议,并且能够在Linux、Unix、BSD等多种系统上运行。 安装 samba: sudo yum install samba配置 samba…

通过阿里云的PAI基于开源LLM搭建RAG检索增强对话系统

5月9日参加阿里云AI云峰会活动,学习了下如何借助阿里云的PAI服务进行搭建RAG检索增加对话系统。 前提: 为了方便省钱,建议先通过免费的优惠圈,这样就可以先不花钱学习一下啦。开始实验之前,请务必打开 阿里云免费试用…

VUE 滚动到指定区域scrollIntoView

背景&#xff1a;当前 VUE 页面数据量很大&#xff0c;右侧出现滚动条, 进入该页面&#xff0c;页面定位到指定区域&#xff1b; 项目要求&#xff1a; 进入页面&#xff0c;定位到指定行&#xff08;红色标记&#xff09; 直接看效果&#xff1a; 代码demo&#xff1a; <…

堆的概念及结构

目录 堆的性质&#xff1a; 堆的实现 堆向下调整算法 堆的创建 堆的插入 堆的删除 堆的应用 堆排序 对比冒泡的优势&#xff1a; 代码 头文件 源文件 如果有一个关键码的集合K { &#xff0c; &#xff0c; &#xff0c;…&#xff0c; }&#xff0c;把它的所有元…

操作系统磁盘管理类问题

例题&#xff1a;在磁盘上存储数据的排列方式会影响1/0服务的总时间。假设每个磁道被划分成10个物理块&#xff0c;每个物理块存放1个逻辑记录。逻辑记录R1,R2....R10存放在同一个磁道上&#xff0c;记录的排列顺序如下表所示&#xff1a; 假定磁盘的旋转速度为10ms/周&#xf…

问界新M5交付,「975」组合站稳中国豪华智电定位

‍作者 |老缅 编辑 |德新 5月15日&#xff0c;问界新M5已正式开启全国用户交付。从网传图片可以看到&#xff0c;华为余承东以及赛力斯AITO问界BU总裁何利扬亲自出席了首批交车仪式。 4月23日&#xff0c;在不到1个月前&#xff0c;新M5发布。新M5共推出三款车型&#xff1a; …

Pikachu 靶场敏感信息泄露通关解析

前言 Pikachu靶场是一种常见的网络安全训练平台&#xff0c;用于模拟真实世界中的网络攻击和防御场景。它提供了一系列的实验室环境&#xff0c;供安全专业人士、学生和爱好者练习和测试他们的技能。 Pikachu靶场的目的是帮助用户了解和掌握网络攻击的原理和技术&#xff0c;…

你好 GPT-4o!

你好 GPT-4o&#xff01; OpenAI公司宣布推出 GPT-4o&#xff0c;这是OpenAI的新旗舰模型&#xff0c;可以实时对音频、视觉和文本进行推理。 GPT-4o&#xff08;“o”代表“o​​mni”&#xff09;是迈向更自然的人机交互的一步——它接受文本、音频、图像和视频的任意组合作…

财富加速器!AI智能无人直播,矩阵操作引领您卖货、卖团购券、拓客,助力财富梦想实现!

财富加速器&#xff01;AI智能无人直播&#xff0c;矩阵操作引领您卖货、卖团购券、拓客&#xff0c;助力财富梦想实现&#xff01; 在当今数字化时代&#xff0c;AI智能技术正以惊人的力量催生新的商机&#xff0c;为经济增长注入源源不断的动力。如果您渴望实现财富梦想&…

go语言数组与切片

1.数组 数组 类型名是[n]elemetType&#xff0c;其中n是数组长度&#xff0c;elementType是数组元素类型。比如一个包 含2个int类型元素的数组类型可表示为[2]int。 数组一般在创建时通过字面量初始化&#xff0c;单独声明一个数组类型变量而不进行初始化是没有意义的。 packa…

Linux-CentOS-7忘记密码-修改登录密码图文详解

Linux-CentOS-7忘记密码-修改登录密码图文详解 1.重启系统&#xff1a; 在登录界面&#xff0c;选择要登录的用户并点击"Power"按钮&#xff0c;然后选择"Restart"或"Reboot"重新启动系统。 在系统启动时持续按下 “e” 键进入编辑模式。 2…

人工智能到底是什么玩意儿?

说实话&#xff0c;每次听到“人工智能”这个词&#xff0c;我都感觉像是在听天书一样。它似乎总是被包裹在一堆高大上的术语和概念里&#xff0c;让人摸不着头脑。但今天&#xff0c;我决定挑战一下自己&#xff0c;把这个问题搞个明白&#xff01; 首先&#xff0c;我得承认&…

通过gen_compile_commands.py产生compile_commands.json文件的方法

大家在使用vscode查看linux源代码时&#xff0c;会有很多飘红处&#xff0c;而且函数的跳转非常不方便。所以linux给了一个脚本gen_compile_commands.py&#xff0c;此脚本类似ctags这样&#xff0c;产生相应的关联之类的数据库&#xff0c;方便函数及文件的跳转等等。非常好。…

每日一练 2024.5.16 (补 2024.5.15)

题目&#xff1a; 给定一个 正整数 数组 beans &#xff0c;其中每个整数表示一个袋子里装的魔法豆的数目。 请你从每个袋子中 拿出 一些豆子&#xff08;也可以 不拿出&#xff09;&#xff0c;使得剩下的 非空 袋子中&#xff08;即 至少还有一颗 魔法豆的袋子&#xff09;…

Docker mysql主从同步

1. 在主节点注册一个账号&#xff0c;用于子节点访问主节点 #mysql 1主2从&#xff0c;先创建主节点 ,注意 \ 后面不要带空格 docker run --name mysql-m \ -v /usr/local/mysql/data:/var/lib/mysql \ -v /usr/local/mysql/conf:/etc/mysql/conf.d \ -v /usr/local/mysql/log:…

20231911 2023-2024-2 《网络攻防实践》实践九报告

1.实践内容 1.1 缓冲区 缓冲区是内存空间的一部分&#xff0c;在内存中预留了一定的存储空间&#xff0c;用来暂时保存输入和输出等I/O操作的一些数据&#xff0c;这些预留的空间就叫做缓冲区。 1.2 shellcode shellcode是一段用于利用软件漏洞而执行的代码&#xff0c;也可以…

哪款桌面便签app能帮助我提升工作效率

作为上班族&#xff0c;我们每天都要处理大量的工作事项&#xff0c;从策划方案到处理邮件&#xff0c;每一个环节都需高效且有条不紊。在这样的工作环境下&#xff0c;提升效率显得尤为重要。而选择一款优秀的桌面便签app&#xff0c;无疑是提高工作效率的关键。 桌面便签app…

6-10 阶乘计算升级版

void Print_Factorial ( const int N ) {if(N<0){printf("Invalid input");return;} int nN;int a[10000]{};a[0]1; //0和1的阶乘都是1&#xff0c;同时又是用该个位去&#xff0c;所以初始化为1&#xff1b;int i,j;int len0;//当前数组所占的最大下标in…