
前言 Preface
汉得飞搭 aPaaS 低代码平台(FEIDA,以下简称“飞搭”)是基于低代码理念打造的融合 aPaaS 平台,助力企业快速搭建业务应用。作为 HZERO 生态的重要组成部分,致力于充分融合 HZERO 的各平台能力,提供企业用户在线化灵活搭建业务应用的能力,支撑企业普惠化(低门槛、高协作)、敏态化(高效率) 和低成本化地快速响应市场变化,加速复杂业务场景落地。
概要介绍
飞搭以动态领域模型(即业务对象)为基础驱动,基于建模可以通过业务对象、页面设计器等功能快速完成功能页面配置。飞搭现已支持数据库表的模型构建,而在当前企业沉淀了越来越多API资产的情况下,飞搭新增API建模及应用的能力,可将内外部API接口构建为业务对象进行页面搭建,将API资产做进一步加工应用,实现更多、更灵活的业务应用,实现企业API资产利用最大化。
例如企业存在MDM和ERP两个系统,客户主数据存在于MDM系统中,需要通过ERP系统进行数据处理,而ERP系统无法直接使用MDM的数据库,所以现在只能通过ERP调用MDM提供的客户查询接口进行数据查询,并提供客户管理页面供用户进行数据操作。
为了满足需求,我们以往是开发人员手写开发页面以对接查询接口并维护参数映射,传统方式成本高、投入大、开发时间长且维护不易。而当前,飞搭提供的API模型及API类型业务对象功能,可将API接口进行建模以搭建页面,实现API接口快速可视化。
API转化页面流程示意图
API转化为实际业务应用需要经过API模型功能进行建模,之后创建API类型业务对象,再基于API业务对象来搭建应用页面。接下来,基于上述场景带你了解API如何一步一步转化为实际功能应用。
『一』将API进行建模
API是抽象的,业务人员难以直接利用。飞搭提供API模型功能,支持将API进行模型构建,以供后续使用。
01. 定义通用API类型
业务对象通用API:
飞搭创建物理表模型业务对象,对象在发布后会生成一整套增删改查的通用API,例如分页查询API、批量新增API、批量删除API等,这一整套通用API是固定的。用户在基于业务对象搭建的页面上进行数据的增删改查等操作时,会执行对应的通用API,将页面数据作为入参,执行后将API返回结果作为出参返回给页面。
页面上的数据操作行为灵活自由,例如查询操作,可根据需求场景分为分页查询、列表查询、详情查询等不同查询操作,因此业务对象也提供了一整套通用API类型以供响应页面的各种数据操作。例如同为GET请求方式,业务对象通用API分为分页查询API、列表查询API、详情查询API等。

外部API接口仅有GET、POST、UPDATE等请求方式,相对于业务对象而言略显宽泛,为了能够将外部API接口与业务对象通用API一一对应,需要在API建模时定义其通用API类型。
例如一个GET请求方式的外部API接口用来查询数据详情,在进行API建模时,需要定义其通用API类型为【详情查询】,之后基于该API模型构建的业务对象在执行详情查询时,就会执行该API接口。

02. 定义出入参结构
通用API出入参:
当业务对象不同时,通用API的出入参结构是不同的。例如分页查询API入参为object结构、出参array结构;批量新增API入参array、出参array等,不同API类型的不同出入参结构是为了能够准确的反馈页面相关的数据操作。


外部API接口的出入参结构已由技术人员定义好,因此构建API模型时只需要根据需求选择好通用API类型即可,然后再维护好出入参的参数信息(参数信息需要与API的实际出入参相同,否则可能会执行失败或无效)即完成了API模型的构建。
例如上述场景,MDM系统提供了一个数据批量查询作用的接口,可以将其定义为列表查询通用API类型,接口里已经定义好了出入参信息,我们将出入参信息维护到API模型里,即可完成API模型的构建,之后我们可以基于API模型构建业务对象及搭建功能应用了。

『二』API业务对象构建
外部API建模之后,就可以基于构建的API模型创建API类型业务对象以供搭建页面。
物理模型业务对象:
基于数据物理表构建模型以创建业务对象。
API模型业务对象:
基于API构建模型以创建业务对象。
01. 维护对象接口
前面提到,飞搭业务对象有一套标准的增删改查通用API,而对于API类型业务对象而言,其只是一套接口执行方式,在对象发起执行请求时具体执行什么API,需要用户在对应通用API类型下去维护需要实际执行的API。


例如文首的案例,MDM系统仅提供数据的查询接口,接口定位为根据id查询数据详情,则在构建API对象之后,需要在接口维护-详情查询的通用API下关联我们第一步构建的API模型。在这之后,该对象发起详情查询时就会执行客户提供的接口。

02. 参数维护
用户维护业务数据属性是通过页面上的字段维护的,在数据进行增删改查操作时通过页面字段作为入参传给对应API后,再将执行出参返回给页面字段。

物理模型业务对象的增删改查API是系统自动生成的,因此字段与API参数是一一对应的,例如对象维护字段name,则增删改查API的出入参里都有name参数且对应name字段。
而API业务对象是基于API模型构建的,所以每个通用API的出入参可能均不相同,因此用户需要根据业务需求自定义维护字段与不同API的出入参参数之间的映射关系。

为什么需要维护字段与API参数的映射?
API出入参参数只提供参数基础属性,以保证API的正常执行;而字段具有一定的业务属性,可以满足业务个性化需求。因此可创建满足业务需求的字段,再将其与对应API中的出入参参数进行映射,这样既可以保证数据的准确执行,也可满足业务需求。
『三』页面设计器搭建页面
通过前两步,我们将外部API接口进行了建模并构建业务对象,接下来就可以去搭建页面了。
对于页面设计器来说,物理模型对象与API对象并没太大区别,页面设计器只关注业务对象中提供的字段,按照常规操作,通过拖拉拽搭建页面即可。
搭建页面完成之后,用户对数据进行增删改查操作时即可执行维护的API接口。

总结
实现API资源功能化总共分为三步操作:
第一步,利用API模型功能对API进行建模,维护好出入参信息;
第二步,基于API模型构建业务对象,维护通用API与API模型的关联、参数与字段的映射等;
第三步,基于API业务对象搭建页面实现功能落地。
结语 Ending
本篇介绍了API转换为功能应用页面的使用场景及快速实现方案,展现了强大的API应用能力,提高了API资产利用率、降低了使用门槛、节约了开发维护成本。
业务模型不仅可应用于飞搭实现多种业务/功能快速配置落地,它同时是 HZERO 数字化平台生态的重要组成部分,可为集成平台、流程平台、数据平台等提供统一数据模型能力、统一数据操作能力等,帮助高效率的实现业务数据的流转、数据资产的整合及共享等,是数字化平台的新型先进生产力基石。
接下来,我们将持续推出飞搭平台各模块的专题系列教程,帮助您更好地掌握飞搭平台的使用技巧,敬请期待!
联系我们 CONTACT US
1. 如果您想了解飞搭更详细的功能介绍和产品信息请查阅我们的产品文档:
请在PC端打开 👉汉得焱牛开放平台
open.hand-china.com/document-ce…
2. 如果您有疑问或者建议,可以通过开放平台进行工单反馈,问题分类请选择【产品/汉得aPaaS平台-飞搭】:
请在PC端打开👉汉得焱牛开放平台
3. 相关产品咨询或更多信息了解,欢迎联系我们




