找回密码
 立即注册

QQ登录

只需一步,快速开始

phoben 讲师达人认证 悬赏达人认证 活字格认证
论坛元老   /  发表于:2024-4-10 14:15  /   查看:1848  /  回复:4
本帖最后由 Patrick.Zhu 于 2024-4-17 15:16 编辑

目前活字格的插件开发API中,对于返回值的定义支持对象和数组,常规来说,对于普通单层的数组,我们使用官方提供的API足够使用,代码如下:

  1. public IEnumerable<GenerateParam> GetGenerateParams()
  2.         {
  3.             yield return new GenerateListParam()
  4.             {
  5.                 ParamName = this.ResultTo,
  6.                 Description = "查询学生的详细信息结果",
  7.                 ParamScope = CommandScope.All,
  8.                 ItemProperties = new List<string>() {
  9.                     "姓名",
  10.                     "年龄"
  11.                 }
  12.             };
  13.         }
复制代码


但是在很多时候,第三方返回的结果,并不只是一个单层的数组,可能数组内还嵌套着其他数组对象,例如下方是税务一个接口返回的数据结构。




这只是一个很平常的接口返回数据,它首先返回了一个数组,然后内部属性中,还有一个也是数组。这种嵌套有时候能达到2-3层以上。

虽然说,我们直接将返回值给到用户,用户通过手动输入属性名,也能正常访问到该属性值
但这无疑给用户使用插件设置了一个很大的门槛,他必须熟悉第三方的API文档,了解它有什么属性,在什么位置,才能准确的拿到值。

插件封装的意义,就在于让用户可视化的方式,通过点选、查看参数描述等,方便的调用API和获取数据,这样一来这个目的就达不到了。

所以建议官方在新的版本中,对插件API进行优化,尤其对于返回值,看能否使其支持多层结构的定义,让命令提示做到和返回值同步,使用户能轻松使用。

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?立即注册

x

4 个回复

倒序浏览
robert
金牌服务用户   /  发表于:2024-4-10 14:22:32
沙发
回复 使用道具 举报
小侠米
论坛元老   /  发表于:2024-4-10 15:08:05
板凳
必须支持。。。。。。。
回复 使用道具 举报
Patrick.Zhu
银牌会员   /  发表于:2024-4-12 14:55:49
地板
调查和讨论下,有任何结果第一时间过来回复
回复 使用道具 举报
Patrick.Zhu
银牌会员   /  发表于:2024-4-17 15:16:58
5#
感谢反馈,需求已记录,需求编号:FORGUNCY-22253,有任何进展会第一时间回复。
回复 使用道具 举报
您需要登录后才可以回帖 登录 | 立即注册
返回顶部