发布说明

发布版本：苍穹V4.0

适用范围：苍穹开放平台所有用户

上线日期：2021-03-10

补丁号：V4.0.017（BOS）

更多内容

变更记录

1 适用范围

OpenAPI支持将接口发布为WebService协议，支持SOAP1.1、SOAP1.2 协议标准。

服务发布方式如下：

• 低代码开发：使用配置的方式将操作对象发布操作API；

• 高代码开发：用 JAVA代码可开发复杂的接口逻辑，并发布为自定义API。

2 操作API发布WebService

2.1 零代码配置操作API

以采购订单保存接口为例，维护API基本信息和请求参数等信息。

2.2 维护WebService信息

• ‌命名空间（targetNamespace）‌：指定Web服务的命名空间，是Web服务的一个全局唯一标识符，用于确保Web服务的唯一性和可寻址性。

• ‌输入参数名‌：用于标识WebService接口的输入参数。

• 输出参数名‌‌：用于标识WebService接口的输出参数。

• ‌WSDL方法名‌：根据业务需求、功能描述定义Web服务的具体方法名，方便进行测试和管理。

2.3 测试WebService接口

点击API测试按钮，即可快速测试接口。也可以导出WSDL，在接口测试工具如SOAPUI中进行测试。

3 自定义API发布WebService

3.1 定义出入参实体类

为出入参定义 Java 实体类，可使用相应的注解标识字段描述及校检参数取数范围、是否必填等。

注：Java 实体类应继承 Serializable 接口

3.2 开发控制类 APIController

3.3 配置自定义 API

路径：【开放服务云】 →【OpenAPI】 →【API管理】→ 【API开发】，点击“新增”按钮，添加 “自定义API”。

操作步骤：

    1）选择所属应用，填写 API 编码及名称，API 分类。

    2）在“类名”处输入你的控制类全路径名称，如：kd.bos.openapi.base.custom.demo.CustomDemoTestController 。

    3）选择方法名（在 WebService 信息一节可以修改其命名空间）。

3.4 测试 API

点击API测试按钮，可快速调试、验证 API 逻辑是否正确。

3.5 使用 SoapUI 测试 WebService

务 URL/kapi/API 请求地址。如：http://localhost:8080/ierp/kapi/v2/ai/openapi/test2/getCustomTest

s_token=1134768014277739520_3gBxxxxx

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

c) 在SoapUI中测试Webservice 接口