快速获取API状态的三种方式

在研发过程中，由于迭代更新的速度很快，API随着产品迭代不断调整，记录与通知API成为了一件麻烦事。而工具能很好的解决这一难题。

1、单个API通知

在我们使用Eolinker管理API的时候，希望通知到团队开发或者测试人员，可以在需要通知的API中设置 单个API的变更通知。

2、项目通知

还可以在项目设置 - API / 文档变更通知 – 添加通知事件 进行批量的项目API变更通知

单个API与项目API通知支持站内信与邮件通知。

3、调用webhook

除了这种方式，Eolinker中支持webhook调用的方式进行通知，这是webhook文档教程地址： https://help.Eolinker.com/webhook/html/usage.html

还可以用于钉钉、企业微信、飞书的通知

那么需要怎么实现呢？

需要先准备一个脚本，以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状态就可以了。

点击确定后，如d出地址错误，则需要检查以下原因：

(1)填写的通知地址是否成功创建了此脚本文件

(2)访问地址、文件名填写是否有误

(3)服务器文件权限、链接重定位问题

（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

以下省略具体项目的构建配置，只记录触发器的配置。

ps: 因为不熟悉jenkins配置，一开始就误会了token的对应关系，图5两个选项是独立的设置，还是要多学学英文呢。

群机器人是钉钉群的高级扩展功能。群机器人可以将第三方服务的信息聚合到群聊中，实现自动化的信息同步。目前，大部分机器人在添加后，还需要进行Webhook配置，才可正常使用(配置说明详见 *** 作流程中的帮助链接)。

例如：

通过聚合GitHub，GitLab等源码管理服务，实现源码更新同步。

通过聚合Trello，JIRA等项目协调服务，实现项目信息同步。

另外，群机器人支持Webhook协议的自定义接入，支持更多可能性，例如：你可将运维报警通过自定义机器人聚合到钉钉群实现提醒功能。

消息发送太频繁会严重影响群成员的使用体验，大量发消息的场景（譬如系统监控报警）可以将这些信息进行整合，通过markdown消息以摘要的形式发送到群里。

每个机器人每分钟最多发送20条。如果超过20条，会限流10分钟。

登录钉钉PC客户端(请升级至最新版)， *** 作入口：

窗口右上角点击【头像】，进入”机器人管理“， 可对所有机器人进行统一管理。

进入一个钉钉群，在群的顶部功能栏中，点击【群设置】，进入菜单可以看到【群机器人】的入口，点击进入“群机器人”的管理面板后，可以进行添加、编辑和删除群机器人的 *** 作。

我们这里使用最后一个webhook

步骤一，在机器人管理页面选择“自定义”机器人，输入机器人名字并选择要发送消息的群。如果需要的话，可以为机器人设置一个头像。点击“完成添加”，完成后会生成Hook地址，如下图：

步骤二，点击“复制”按钮，即可获得这个机器人对应的Webhook地址，其格式如下：

（1）获取到Webhook地址后，用户可以向这个地址发起HTTP POST 请求，即可实现给该钉钉群发送消息。注意，发起POST请求时，必须将字符集编码设置成UTF-8。

（2）当前自定义机器人支持文本 (text)、链接 (link)、markdown(markdown)、ActionCard、FeedCard消息类型，大家可以根据自己的使用场景选择合适的消息类型，达到最好的展示样式。

（3）自定义机器人发送消息时，可以通过手机号码指定“被@人列表”。在“被@人列表”里面的人员收到该消息时，会有@消息提醒(免打扰会话仍然通知提醒，首屏出现“有人@你”)。

（4）当前机器人尚不支持应答机制 (该机制指的是群里成员在聊天@机器人的时候，钉钉回调指定的服务地址，即Outgoing机器人)。

---