快速获取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发送的信息,转成数组格式
eo_hook = json_decode(file_get_contents("php://input"),1); //组装需要打印的内容text = "Eolinker API 状态通知:".PHP_EOL."API变更状态:".eo_hook['content']['API_list'][0]['API_status'].PHP_EOL."API名称:".eo_hook['content']['API_list'][0]['API_name'].PHP_EOL."工作空间名称:".eo_hook['space_name'].PHP_EOL."修改时间:".eo_hook['hook_request_time'].PHP_EOL."修改人:".eo_hook['hook_operator'].PHP_EOL."API_uri:".eo_hook['content']['API_list'][0]['API_uri'];
data = [ 'msg_type' => '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空间中,会看到左侧导航栏会有设置按钮的小图标,点击 工作空间设置


进入空间设置后,选择 webhook ,点击新建服务调用


然后把刚刚创建的脚本地址以,ip地址/jiaoben.php的形式填入,然后更改API状态就可以了。


点击确定后,如弹出地址错误,则需要检查以下原因:
(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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351

推荐阅读更多精彩内容