在研发过程中,由于迭代更新的速度很快,API随着产品迭代不断调整,记录与通知API成为了一件麻烦事。而工具能很好的解决这一难题。
1、单个API通知
在我们使用Eolinker管理API的时候,希望通知到团队开发或者测试人员,可以在需要通知的API中设置 单个API的变更通知。
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180630798-580541630.png)
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180631001-693559904.png)
2、项目通知
还可以在项目设置 - API / 文档变更通知 – 添加通知事件 进行批量的项目API变更通知
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180631232-190400707.png)
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180631464-1056583954.png)
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180631737-84998233.png)
单个API与项目API通知支持站内信与邮件通知。
3、调用webhook
除了这种方式,Eolinker中支持webhook调用的方式进行通知,这是webhook文档教程地址:https://help.Eolinker.com/webhook/html/usage.html
还可以用于钉钉、企业微信、飞书的通知
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180631949-502655580.png)
那么需要怎么实现呢?
需要先准备一个脚本,以php为例子。如:
'text',
'content' => [
'text' => $text,
]
];
//判断如果产品为API研发管理 且 事件为API文档 且 操作为切换API状态 则调用你想调用的接口、函数
if($eo_hook['hook_product'] == 'API_management' && $eo_hook['hook_event'] == 'API_document' && $eo_hook['hook_operation'] == 'switch_API_status'){
//自己需要调用的东西,如飞书提醒服务
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://open.feishu.cn/open-APIs/bot/v2/hook/xxxxxx",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode($data),
CURLOPT_HTTPHEADER => array(
"Content-Type:application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
}
编辑脚本并放在自己的服务器上,然后记录下存放的地址,确定ip+脚本文件名可以访问到。
接下俩我们进入Eolinker空间中,会看到左侧导航栏会有设置按钮的小图标,点击 工作空间设置
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180632161-48927017.png)
进入空间设置后,选择 webhook ,点击新建服务调用
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180632407-1808854300.png)
然后把刚刚创建的脚本地址以,ip地址/jiaoben.php的形式填入,然后更改API状态就可以了。
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180632591-2003034183.png)
点击确定后,如弹出地址错误,则需要检查以下原因:
(1)填写的通知地址是否成功创建了此脚本文件
(2)访问地址、文件名填写是否有误
(3)服务器文件权限、链接重定位问题
![](https://img2020.cnblogs.com/other/1506969/202101/1506969-20210121180632746-1264143344.png)
(1)Eolinker_webhook教程文档:
https://help.Eolinker.com/webhook/html/usage.html
(2)飞书自定义机器人:
https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN#top_anchor
(3)钉钉自定义机器人:
https://ding-doc.dingtalk.com/doc#/serverAPI2/qf2nxq/26eaddd5
(4)企业微信自定义机器人:
https://work.weixin.qq.com/help?person_id=1&doc_id=13376#如何使用群机器人/如何使用群机器人
更多功能探索可以直接在工具上尝试~
使用地址:[www.eolinker.com](https://datayi.cn/w/YoX2N7LR)