场景化接口开发利器，金蝶云苍穹新版OpenAPI引擎来了！

Posted 2022-06-29 Wayne.Zhon_钟伟纯

你是否曾经空有请求地址，却对如何调用接口感到无从下手？

对接外部系统时，你是否也曾为不满足对方格式要求而苦恼？

接口开发完，你是否还在频繁切换调试工具？

API文档不全，最终只能人工编写项目接口文档？

别担心！这些问题，金蝶云·苍穹新版OpenAPI引擎帮你全搞定！

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

功能简介

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

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

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

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

功能详情

01 打开API管理列表

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

编辑

API管理界面

02 零代码配置API

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

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

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

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

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

定义查询条件示例

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

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

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

编辑

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

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

编辑

API测试示例

03 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;

     ...

04 脚本开发API

脚本开发的模式发布API，可实现多个API、微服务、函数库等之间的组合调用，开发便捷，部署灵活，其通过脚本实现逻辑，无需开发Java代码，更便捷。

编辑

脚本开发API示例

05 API文档

路径：【开发服务云】→【开放平台】→【API文档】，此处展示API接口基本信息、请求参数、请求结构示例、返回参数和返回结构示例、错误码等信息；支持导出HTML、PDF文件以及获取匿名链接等功能，帮助开发人员快速上手，提升系统对接效率。

编辑

API文档界面

亮点价值

亮点一：新版API引擎参数扁平化，支持多种入参格式，更易于对接外部系统。

亮点二：操作API无需代码开发，通过界面配置快速生成场景化的接口，使用门槛低，改善开发体验。

亮点三：自动生成API文档，包含完整的请求参数和返回参数示例，可直接用于接口调试，提升用户体验。

亮点四：脚本开发API，提供常用的代码片段，无需编译部署，即时生效，提升开发效率。​

更多金蝶云苍穹的开发知识，请搜索金蝶云·苍穹开发者社区~