导航:首页 > 文件教程 > eolinker教程

eolinker教程

发布时间:2022-09-13 04:12:22

⑴ 快速创建MockAPI

MockAPI顾名思义是一个模拟的API,它可以模拟真实API的请求并返回数据。MockAPI可用于前后端分离,在项目初期前端可使用MockAPI对系统进行开发,而不需要依赖后端开发好正式的API后才开始进行前端开发。

MockAPI可通过搭建MockServer服务器来实现创建。网上有很多教程,一般需要安装node.js、Mock-API等。搭建比较简单,但前置条件需要服务器或使用虚拟机。
API管理工具可以彻底解决服务器搭建问题,他们有现成的生成MockAPI的功能。以下以Eolinker为例,实现快速创建MockAPI并进行测试。
在Eolinker的API管理界面,新建一个API,若已经存在swagger文档,可快速导入。

手动创建一个用于用户登录的API,填写API所需的信息,其中请求参数有user_name、user_password,详细内容如下:

保存后可以查看详细的API文档。

在API文档上方可以找到MockAPI选项,创建MockAPI,当用户名为percy时,则MockAPI返回用户名不存在。

至此MockAPI就创建成功了,前端开发人员可开始调用MockAPI的url进行开发。

下面我们对该MockAPI进行测试,Eolinker不仅提供了API文档,还提供了测试功能。输入MockAPI的url与正确请求格式与参数,测试后可查看到成功返回设置的返回信息。

使用API管理工具不仅可以快速进行Mock与测试,还可以对API进行管理。相比较于传统的API文档,API管理工具更灵活、强大,为团队创造的价值也更加明显。
演示工具: www.eolinker.com

⑵ 如何使用API 网关做服务编排

服务编排/数据聚合 指的是可以通过一个请求来依次调用多个微服务,并对每个服务的返回结果做数据处理,最终整合成一个大的结果返回给前端。

例如一个服务是“查询用户预定的酒店”,前端仅需要传一个订单ID,后端会返回整个订单的信息,包括用户信息、酒店信息和房间信息等。

这个服务背后可能对应着以下几个操作:

微服务架构上对功能做了解耦,使用服务编排可以快速从各类服务上获取需要的数据,对业务实现快速响应。总的来说,编排有以下几点优势:

Goku API Gateway (中文名:悟空 API 网关)是一个基于 Golang 开发的微服务网关,能够实现高性能 HTTP API 转发、服务编排、多租户管理、API 访问权限控制等目的,拥有强大的自定义插件系统可以自行扩展,并且提供友好的图形化配置界面,能够快速帮助企业进行 API 服务治理、提高 API 服务的稳定性和安全性。

Goku API Gateway支持一个编排API对应多个后端服务,每个后端服务的请求参数可以使用前端传入的参数,也可以在编排里自定义(写静态参数或从返回数据里获得)。每个后端服务的返回数据支持过滤、删除、移动、重命名、拆包和封包等操作;编排API能够设定编排失败时的异常返回。

Goku API Gateway 的社区版本(CE)同时拥有完善的使用指南和二次开发指南,内置的插件系统也能够让企业针对自身业务进行定制开发。

项目地址: https://github.com/eolinker/goku-api-gateway

官网地址: https://www.eolinker.com

我们将编排的整个操作放到网关进行,由网关对数据做处理与转换,这样无需对后端服务做改动。一个请求到达网关,网关调用多个后端服务,并且在网关上对各个服务的返回数据做处理(操作有过滤、移动、重命名、封包、拆包,后面会对各操作做详细解释),最后由网关将数据整合好返回给前端。

网关将编排过程中对 API的转发处理过程 (转发->获取返回数据->数据处理)称为一个 Step

添加一个转发服务,该服务为 查询订单详情API,配置相应的转发地址、传入的参数、对返回数据做何种处理等。

由于篇幅原因,后续的Step(查询用户详情、查询酒店详情、查询房间详情)就不一一展示了。

网关将编排过程中对 API的转发处理过程 (转发->获取返回数据->数据处理)称为一个 Step。

我们将处理查询订单详情API称为 Step1 ,其中Step1的返回数据有:用户ID、酒店ID、房间ID。同理,将查询用户信息这步称为 Step2 ,将查询酒店信息称为 Step3 ,将查询房间信息称为 Step4

传参规则:

以下为转发路径的传参写法:

Step2中需要接收Step1里返回的userID作为参数,同时需要接收前端传入的Authorization参数

在网关里Step2的请求参数配置如下所示,请求参数存在多个的话用换行表示:

1.查询订单详情的API,返回数据称为json1,内容如下:

2.查询用户详情的API,返回数据称为json2,内容如下:

3.查询酒店详情的返回数据,称为json3,内容如下:

4.查询房间详情的返回数据,称为json4,内容如下:

5.可以在每一个Step里对返回Json做处理,网关会将处理过的数据最后整合起来,再返回前端,例如这是通过网关返回的最终数据:

这里以查询酒店详情API的返回数据json3为例,讲解网关如何在编排过程中对返回数据做处理。

查询酒店详情API返回的原始数据如下:

从网关返回给前端的数据中截取酒店信息的数据如下:

从原始数据到处理后的数据需要经过以下操作:

字段黑名单的作用是排除某些字段,支持数组形式。

在网关的Step3里配置如下:

经过网关处理后,实际的返回数据如下,可以看到data对象里的id字段已经被过滤掉:

拆包是指将指定对象的内容提取出来作为该步骤(step)的返回结果。其中匹配目标只能为object,匹配目标为空时,结果为 {},可用于清除数据。

在网关的Step里配置如下:

经过网关处理后,实际的返回数据如下,可以看到data对象被拆开,最终数据仅保留了data对象里面的字段:

字段封包会将当前的数据整体打包为最终返回数据中的一个对象,不支持*,不支持数组。

在网关的Step里配置如下:

经过网关处理后,实际的返回数据如下,数据被整体打包为hotelinfo对象:

经过三个步骤,就可以将原始数据变成最终的数据。

本文仅列举了编排过程中部分数据处理的操作,如需了解更多编排细则,可通过文末给出的教程链接。

相关链接

⑶ 快速获取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状态就可以了。

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

阅读全文

与eolinker教程相关的资料

热点内容
手机百度查看过的网站怎么删除 浏览:620
applemusic支持哪些文件格式 浏览:79
全省统一编程是什么意思 浏览:501
现在的编程课有哪些 浏览:820
网站页面如何转文档 浏览:179
译官大数据 浏览:619
华为手机中录音文件保存在哪里 浏览:854
网络技术公司的组织架构 浏览:330
大数据视频收视率 浏览:973
2017新版本赵云技能 浏览:776
java大数据教程pdf 浏览:927
木槿花西月锦绣小说在哪个app看 浏览:263
qrcode二维码生成工具 浏览:18
电脑上的ps忘记安装在哪个文件夹 浏览:781
莱山区机器人编程培训教的怎么样 浏览:479
关于小学生编程有什么书 浏览:268
商务数据分析的基本原则有哪些 浏览:179
湖泊cod数据哪里有 浏览:590
网站需要多大数据库 浏览:781
java根据出生日期判断是否成年 浏览:614

友情链接