为开发量身打造的WebAPI登记器,它来了
为了对接客户的ERP系统,某现场开发小A需要把对方系统开放的WebAPI登记到苍穹中。小A同学作为开发有非常多的WebAPI调通经验,postman耍的也是风生水起。
那么,在苍穹进行WebAPI登记时还能否继续沿用他过往的经验呢?“如果能把postman调通的WebAPI直接导入到苍穹中就好了”,小A不禁这样想。
那么小A的想法能实现吗?让我们一起来一探究竟吧~
1 适用版本
该功能适用版本为金蝶云·苍穹V5.0.011及以上。
注:该功能暂为灰度发布,如有需要请联系集成服务云部门。
2 功能详情
WebAPI登记是通过前台配置的方式,在苍穹中登记外部系统的WebAPI,从而能够在苍穹中快速调用外部系统的接口,并统一管理连接鉴权和调用日志等信息,功能详情如下:
2.1 根据curl自动创建
在postman中调通的WebAPI可以导出curl文件,并在WebAPI中导入自动生成API模型,如下图所示:
导入curl文件
自动创建示例
2.2 手工创建
首先,选择数据源,并补充完整WebAPI的调用url及请求信息。对于请求过程的参数信息,可以双击“参数值”单元格,选择对应变量,填充参数值,如下图所示:
请求信息示例
选择参数
其次,开启“格式化响应结果”,并根据响应体自动生成响应数据模型,如下图所示:
响应结果示例
根据相应结果生成数据模型
然后,保存登记信息。如果需要对整个调用过程进行额外调整,还可以开启“脚本模式”,可以对调用原始脚本进行修改,以符合需求。
脚本模式
最后,当API登记并测试好以后,可以在服务流程中引入该资源进行使用,或是通过微服务接口直接调用。
3 亮点价值
亮点一:根据curl快速登记
可以将postman中调通的WebAPI导出为curl文件,根据curl文件快速登记WebAPI。
亮点二:符合开发习惯的API登记过程
在表单页面中,可以定义请求信息和响应信息的数据结构,并且可以选择引用连接配置中的鉴权变量,以此作为WebAPI完整的调用信息(还支持在线调试哟~)。
亮点三:支持切换脚本模式应对复杂场景
针对请求信息或响应信息要特殊处理的WebAPI,支持切换为脚本模式,直接查看和修改WebAPI调用的原始脚本,以应对各种复杂场景。
4 常见问题
问:WebAPI调用中使用的鉴权信息是否是共用的?鉴权流程该如何定义呢?
答:登记WebAPI的时候,选择的数据源就涵盖了该系统的鉴权信息,当数据源创建好后,则此部分鉴权信息是可以复用的。鉴权流程的定义在连接类型中,可以选择已有的连接类型或创建新的连接类型。
5 相关链接
https://vip.kingdee.com/article/183681
6 划重点
金蝶云·苍穹V5.0H2—集成服务云WebAPI登记功能新增特性如下:
1) WebAPI登记支持导入curl快速登记WebAPI。
2) 手工创建WebAPI支持补全完整调用url以及请求信息,并能根据响应结果生成响应数据模型。
3) 针对复杂调用场景支持切换脚本模式,修改原始调用脚本,对请求信息或响应结果进行额外处理。
#往期推荐#
更多精彩内容,“码”上了解!↓
为开发量身打造的WebAPI登记器,它来了
本文2024-09-23 00:48:08发表“云苍穹知识”栏目。
本文链接:https://wenku.my7c.com/article/kingdee-cangqiong-141832.html