1 适用版本

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

2 功能简介

新版OpenAPI引擎相较旧版本的API引擎，入参扁平化，更易于第三方系统解析。支持JSON、XML、SOAP1.0、SOAP1.2、form-data、x-www-form-urlencoded等格式的请求参数。开发者能通过以下三种方式进行API开发：

1）零代码配置：按接口调用场景，在API维护界面配置基本信息和请求参数，一键生成OpenAPI。

2）Java插件开发：使用Java代码插件，解决复杂的业务场景，如调用微服务或对文件流、图像等进行处理。

3）脚本开发：使用脚本，可实现多个API、微服务、函数库等之间的组合调用，开发便捷，部署灵活。

3 功能详情

3.1 打开API管理列表

路径：【开发服务云】→【开放平台】→【API管理】，此处统一管理所有新版本（V2）的API接口，点击“新增”按钮，在弹窗中可选择创建“操作API”或“自定义API”。

API管理界面

3.2 零代码配置API

如何零代码维护API呢？以最常见的查询操作接口为例，分为以下步骤：

1）录入API基本信息：API编码、API名称、业务对象、操作方式、详细描述，API请求地址自动生成。

2）定义请求头部：无需维护，系统预置了content_type(内容类型）和accesstoken（请求令牌）两个参数。

3）定义query参数：即定义请求的入参，这些参数会作为查询条件的比较变量，界面设置参数类型和是否必填。

4）定义查询条件：即定义查询类请求的过滤条件，将业务对象中的字段和传入参数（比较变量）进行比较，来过滤筛选指定的数据，同时支持常量查询。

定义查询条件示例

5）定义排序（可选）：用户可在界面定义返回参数展示的排序方式。

6）定义返回参数：即定义请求的出参，确认后点击“保存”按钮，则完成API维护。

7）定义错误码：定义请求错误码和描述。

定义返回参数和错误码示例

8）维护完毕后即可进行在线测试，点击按钮“API测试”，可实时调试API接口。

API测试示例

3.3 Java代码插件开发API

Java代码插件开发自定义API，主要解决复杂的业务场景，如调用微服务或对文件流、图像等进行处理。用户预先定义好类和方法，在开放平台进行简单的接口配置后，系统便会自动解析定义好的请求参数和返回参数，快速方便地生成自定义接口。

自定义API配置示例

相关代码示例如下：

@ApiModel
public class CustomDemo2Model implements java.io.Serializable {
    private static final long serialVersionUID = 703398913563944102L;
    @ApiParam("ID")
    private Long id;
    @ApiParam(value = "编码", required = true)
    private String number;
    @ApiParam(value = "名称", required = true)
    private String name;
    @ApiParam("余额")
    private int balance;
    @ApiParam("日期")
    private Date date;
     ...
}