【广西用友u8】OpenApi查询类接口如何增加属性？

OpenApi查询类接口如何增加属性？

一、知识点

U8 开放平台查询类接口的返回属性由两部分配置控制：

datasource：

位于 OpenAPI 客户端安装路径yonyouup\openapi-client\config\META-INF\datasources，用于定义 SQL 查询的字段（可任意定制返回字段）。

rules：位于yonyouup\openapi-client\config\META-INF\rules，用于定义实际返回给调用者的字段（需在 datasource 定义的字段范围内，可排除敏感字段如 id）。

个性化配置需备份：升级客户端时，个性化的 xml 文件可能被覆盖，需提前备份。

二、问题描述

如何在 OpenApi 查询类接口的返回结果中增加属性？

三、问题分析与解决方案

问题分析

查询类接口的返回结果由 datasource 和 rules 共同决定：datasource 定义 SQL 查询的字段范围，rules 从该范围中筛选实际返回的字段。因此，增加返回属性需同时修改这两个配置文件。

解决方案

开放平台客户端安装路径yonyouup\openapi-client\config\META-INF下：

datasource和rules的同时自定义可以实现查询类接口的个性化返回。

需注意：个性化的xml文件请做好备份，升级客户端个性化xml会被覆盖

详细操作

以下以在【获取单个存货档案信息】接口中增加一个【计划价/售价】返回字段为例

修改查询接口对应的查询sql配置文件

1）找到查询接口对应的配置文件

在开放平台网站的API中心上找到对应的API，接口地址中的第一部分就是接口OpenAPI客户端的配置文件名，如下图红框所示

【获取单个存货档案信息】接口地址为inventory/get，所以对应的查询SQL配置文件名为inventory.xml，完整路径为OpenAPI客户端安装目录yonyouup\openapi-client\config\META-INF\datasources\query\inventory.xml

上图是【获取单个存货档案信息】接口对应的配置文件，第一个红框部分为主表SQL，第二个红框部分为子表SQL，其中子表SQL不一定所有单据都有

       2）根据配置文件中的数据来源表，从U8数据库字典表中查找到对应的表，找到对应字段名

经查，在【存货档案】主表inventory中的【计划价/售价】字段的字段名为iInvRCost

3）在配置文件SQL中增加需要的列

参考其他列，在主表SQL中 select区域增加  i.iInvRCost  as invr_cost

4）保存并关闭配置文件

修改返回字段配置文件

1）找到对应接口的返回字段配置文件

在yonyouup\openapi-client\config\META-INF\rules目录下找到接口地址第一部分名相同的目录。

【获取单个存货档案信息】接口地址为inventory/get，所以对应的查询SQL配置文件名为inventory.xml，完整路径为OpenAPI客户端安装目录yonyouup\openapi-client\config\META-INF\rules\ inventory \rule.xml，内容如下图所示：

分为主表和子表返回字段定义部分

2）修改配置文件rule.xml

在文件field_list中增加查询SQL配置文件中新增的查询字段（注：是select SQL语句中的as后的字段名，【计划价/售价】字段名为invr_cost）

3）保存并关闭rule.xml

以上是增加主表字段，子表字段是一样的过程，就是2个文件的定义区域不一样而已

重启OpenAPI客户端即可测试验证