OpenAPI2.0—轻松构建WebService服务原创
金蝶云社区-胡海明
胡海明
4人赞赏了该文章 1,700次浏览 未经作者许可,禁止转载编辑于2022年07月09日 18:59:18

你是否还在使用传统复杂的CXF框架开发WebService接口来对接遗留应用系统?


你是否还在为如何快速轻松地一键生成WebService接口而烦恼呢?


现在,是时候跟所有的烦恼说Bye Bye了~OpenAPI2.0支持将Rest API一键发布为WebService协议接口,支持Soap1.1Soap1.2协议标准。


下面,就跟小编一起来探索OpenAPI2.0新增的功能吧~


适用版本


该功能适用版本为金蝶云·苍穹V4.0.020及以上。


功能速览


OpenAPI2.0支持2种方式将普通的Rest API接口发布成WebService协议接口,如下:


1)  零代码配置方式:将操作对象发布为操作服务API,并添加WebService协议命名空间、输入/输出参数名即可。


2)  Java或脚本插件方式:使用Java代码或脚本插件方式开发复杂的自定义逻辑并发布成WebService服务。


功能详情


配置发布的WebService


1)新建操作API


菜单路径:【API管理】→【新增】 →【操作API(零代码配置)】/【自定义API-Java】/【自定义API-脚本插件】。随后,维护API编码,并配置出入参。


2)维护WebService信息


配置WebService协议命名空间输入/输出参数名


图片

配置WebService示例


测试API


OpenAPI2.0内置了测试功能,可快速调试、验证API逻辑是否正确。在API测试页面,可选择JSON/XML/Soap1.1/Soap1.2协议。


图片

协议选择示例


使用SoapUI测试WebService


OpenAPI内置的API测试工具无需额外获取token,并且可自动构造请求入参,调试接口方便快捷。如果需要给外部客户调试苍穹WebService接口,可以使用第三方SoapUI工具,具体分为三步:


1) 查看WSDL描述


可点击API详情页的“测试”按钮获取完整API地址:http://苍穹服务URL/kapi/API请求地址。


如:http://localhost:8080/ierp/kapi/v2/ai/openapi/test2/getCustomTest


图片

API完整地址


WSDL地址为API地址后添加字符串“?wsdl”。在浏览器中测试或在SoapUI添加WSDL时要先获取token,并在URL后面添加:“&access_token=你的token”


如:http://localhost:8080/ierp/kapi/v2/ai/openapi/test2/getCustomTest?wsdl&access_token=1134768014277739520_3gBxxxxx


2) 在SoapUI中添加WebService接口


将上一步带有accesstoken的URL添加为WSDL。


图片

将accesstoken的URL添加为WSDL


3) 在SoapUI中测试WebService


设置相应的请求参数,注意参数值的类型及值的合法性,并添加请求Headers:accesstoken。点击“测试”按钮,测试返回的Soap报文是否正确。


图片

测试返回值示例


亮点价值


亮点一:零代码配置快速生成API。可将苍穹任何操作对象快速发布成API,无需编写一行代码,方便快捷。


亮点二:一键发布成WebService协议接口。可将任何POST类型的OpenAPI接口,配置WebService参数信息后,发布成符合Soap1.1/Soap1.2协议标准的WebService接口,节省了大量的接口开发时间。


亮点三:一键测试,方便快捷。内置的API测试工具,可快速测试JSON/XML/Soap1.1/Soap1.2接口,无需借助第三方调试工具。


亮点四:功能强大。对于复杂的业务逻辑,可使用Java插件脚本插件开发OpenAPI接口,并发布成WebService协议。



划重点

本次金蝶云·苍穹OpenAPI2.0发布新特性主要体现在:


1)  开放平台可将任何POST协议API接口发布成WebService协议。


2)开放平台支持API、WebService的在线测试,自动构建请求入参。



图标赞 4
4人点赞
还没有人点赞,快来当第一个点赞的人吧!
图标打赏
0人打赏
还没有人打赏,快来当第一个打赏的人吧!