今天给各位分享webhook教程的知识,其中也会对webhook接口进行解释,如果能碰巧解决你现在面临的问题,可以联系我们!
本文目录一览:
- 1、快速获取API状态的三种方式
- 2、钉钉机器人怎么用 钉钉机器人有什么功能
- 3、钉钉机器人怎么用 钉钉机器人使用方法介绍
- 4、Gitlab+Jenkins通过钩子实现自动部署web项目,图文详细教程
快速获取API状态的三种方式
在研发过程中,由于迭代更新的速度很快,API随着产品迭代不断调整,记录与通知API成为了一件麻烦事。而工具能很好的解决这一难题。
1、单个API通知
在我们使用Eolinker管理API的时候,希望通知到团队开发或者测试人员,可以在需要通知的API中设置 单个API的变更通知。
2、项目通知
还可以在项目设置 - API / 文档变更通知 – 添加通知事件 进行批量的项目API变更通知
单个API与项目API通知支持站内信与邮件通知。
3、调用webhook
除了这种方式,Eolinker中支持webhook调用的方式进行通知,这是webhook文档教程地址:
还可以用于钉钉、企业微信、飞书的通知
那么需要怎么实现呢?
需要先准备一个脚本,以php为例子。如:
?php
//获取Eolinker发送的信息,转成数组格式
text = "Eolinker API 状态通知:".PHP_EOL."API变更状态:". eo_hook['content']['API_list'][0]['API_name'].PHP_EOL."工作空间名称:". eo_hook['hook_request_time'].PHP_EOL."修改人:". eo_hook['content']['API_list'][0]['API_uri'];
text,
]
];
//判断如果产品为API研发管理 且 事件为API文档 且 操作为切换API状态 则调用你想调用的接口、函数
if( eo_hook['hook_event'] == 'API_document' curl = curl_init();
curl_setopt_array( data),
CURLOPT_HTTPHEADER = array(
"Content-Type:application/json"
),
));
}
编辑脚本并放在自己的服务器上,然后记录下存放的地址,确定ip+脚本文件名可以访问到。
接下俩我们进入Eolinker空间中,会看到左侧导航栏会有设置按钮的小图标,点击 工作空间设置
进入空间设置后,选择 webhook ,点击新建服务调用
然后把刚刚创建的脚本地址以,ip地址/jiaoben.php的形式填入,然后更改API状态就可以了。
点击确定后,如弹出地址错误,则需要检查以下原因:
(1)填写的通知地址是否成功创建了此脚本文件
(2)访问地址、文件名填写是否有误
(3)服务器文件权限、链接重定位问题
(1)Eolinker_webhook教程文档:
(2)飞书自定义机器人:
(3)钉钉自定义机器人:
(4)企业微信自定义机器人:
;doc_id=13376# 如何使用群机器人/如何使用群机器人
更多功能探索可以直接在工具上尝试~
使用地址:
钉钉机器人怎么用 钉钉机器人有什么功能
钉钉机器人可以用来提醒敬业签上的定时提醒事件,敬业签是一款桌面便签提醒软件,上面有钉钉提醒的功能,可通过钉钉机器人同步推送便签中记录的提醒事件,设置方法如下:
打开敬业签pc软件的系统设置;
在提醒设置中找到钉钉提醒;
输入钉钉机器人的webHook链接后,就可以成功开启钉钉提醒。
不会获取webHook链接的话,可以参考这篇教程演示的步骤解决。
钉钉机器人怎么用 钉钉机器人使用方法介绍
钉钉机器人可以用来同步敬业签这款桌面便签上设置的待办提醒,因为敬业签支持绑定钉钉提醒,能够通过钉钉智能机器人助手同步推送便签中设置的提醒事件,具体的使用方法如下所示:
1、创建一个钉钉群,设置自定义机器人为敬业签,方法可参考教程教程链接
2、复制机器人的webhook链接,粘贴到敬业签开启钉钉提醒的webhook链接框中;
3、在敬业签软件上设置一个定时提醒的事件,等到提醒到期后,钉钉机器人助手同步在钉钉群中推送消息即可。
Gitlab+Jenkins通过钩子实现自动部署web项目,图文详细教程
扩展参考:Jenkins+Gitlab通过脚本自动部署回滚web项目至集群
1):Gitlab服务器:ubuntu 192.168.152.131 ---参考搭建:Linux安装gitlab,docker安装gitlab教程
2):Jenkins服务器:ubunu 192.168.152.130 ---参考搭建:linux安装Jenkins,或docker安装Jenkins教程
在服务器上生成ssh-keygen,用于配置web服务器和Gitlab服务器。
3):web服务器:centos 192.168.152.150 ---已搭建好LNMP环境
4):开发者电脑:Windows+key密钥 (用于提交代码)
1:在gitlab创建项目Test Project
2.1): 配置一个开发者电脑的ssh公钥到gitlab
配置一个开发者电脑的ssh公钥到gitlab,这样才能模拟开发上传代码到gitlab。
windows生成key过程及git安装,可参考:Windows下git和github的使用图文详细教程_the丶only的博客-CSDN博客_github win
在windows测试clone,和提交代码。
注:最新版git 已经将默认分支master改为main了。所以看到main,而不是master不要太奇怪
测试成功,在gitlab也显示有index.html文件。
2.2): 配置jenkins公钥到gitlab
同理,同样需要jenkins公钥,因为jenkins也需要拉去gitlab的代码。
在 jenkins服务器 上查看公钥并复制添加到gitlab,并命名为jekins。
1:插件管理,安装插件
jenkins本身没什么功能,主要是依靠插件来实现各种强大的功能。
基本需要添加的插件:Gitlab Hook、Build Authorization Token Root、Publish Over SSH、Gitlab Authentication、Gitlab、Git Parameter
可以在 Manage Jenkins Manage Plugins 查看管理插件。在Available 选项搜索安装插件即可。
安装完成后,重启Jenkins。
2:添加需要部署的web主机
在 Manage Jenkins Configure System 中往下翻,找到 Publish over SSH 选项,点击add ssh server。
在Jenkins服务器上,查看私钥,注,是私钥,不是公钥。
将私钥填写在key位置,还有添加web服务器相关信息。
注:如果测试报错如下
Failed to connect or change directory
jenkins.plugins.publish_over.BapPublisherException: Failed to add SSH key. Message [invalid privatekey: [B@2e54414f]
是因为默认用ssh-keygen命令,默认生成了OPENSSH 格式密钥。而Jenkins暂时不支持这种私钥,私钥开头结尾如下:
所以,需要生成rsa密钥格式的。用开头说的ssh-keygen加其他参数生成即可。
私钥开头结尾如下:
再次测试,显示success,则成功。然后点击save保存即可。
3:构建任务项目
首页创建任务或者一个项目
命名为web-project,选择为freestyle project 自由项目。然后ok确认。
3.1):源码管理 Source Code Management
选择源码管理,添加gitlab的项目clone地址。
注:最后路径选择分支,我gitlab主分支名字为main,如果是master,则写master,或者合并的其他分支。
在add添加用户
添加完成后,选择git用户,这时没有红色提醒,说明已成功连接
3.2):构建触发器 Build Triggers
现在Build Triggers,勾选build when....,其他默认,并记下链接
点击高级 advance 选项。
勾选filter branches regex选择,填写分支,生产token。其他默认
3.3):构建 Build
选择Build 选项。选择ssh
添加web服务器
添加完毕,最后save保存。
1:添加钩子webhooks.
选择自己的项目Test Project,在设置setting里,选择钩子webhooks.
填写刚才记下的和token值。
最后Add webhook完成:
2:如添加失败,报错,更改Network
注:如填写失败提示Url is blocked: Requests to the local network are not allowed
还需更改Network选项。
3:测试钩子
添加完成后,下面会出现钩子选择。点击test中的,push event。
出现successful,即添加成功。
在Jenkins也可以看到刚才的测试时间信息。
在开发电脑上测试提交,我这里为Windows电脑测试。
打开Git Bash,输入以下命令:
提交成功,回到Jenkins,查看是否构建成功:
绿色显示构建成功,无错误显示。回到gitlab查看项目。
时间显示刚才也提交成功,无错误。最后在浏览器输入web地址测试,本人配置了web访问端口8082。所以输入IP加端口访问。
内容也已经自动更新成功。
完结撒花!!!
关于webhook教程和webhook接口账户介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得关注我们官网。