非纯脚本服务定义
操作场景
聚合服务编排提供可视化图形化的API编排能力。基于此能力，开发人员无需再从零开始编写复杂的代码，只需通过简单的拖拉拽和配置，就可轻松完成API的编排，极大的提高了API的开发效率和灵活性。
前提条件
已获取开发人员及以上权限用户的账号和密码。
步骤1：定义基本信息
- 登录LinkX-F系统首页。
- 选择，进入“聚合服务编排”页面。
- 单击“创建”，弹出“创建聚合服务”界面。
默认进入“服务定义”页的“基本信息”阶段。
- 根据界面提示，配置如下基本信息，如表1所示：
图2 定义服务基本信息
表1 服务定义基本信息 参数
说明
基本信息
API英文名称
根据API提供的功能，自定义API的英文名称。
必填，不能重复，可包含字母、数字和英文半角“_”不能包含特殊字符，字首只能是大写字母，长度不能超过128个字符。
API中文名称
根据API提供的功能，自定义API的中文名称。
必填，不能重复，可包含中文、英文、数字和英文半角“-”“_”，长度不能超过 128 个字符。
API英文描述
输入API的英文描述，说明API的功能等信息。
必填，可包含英文、数字、特殊字符和空格，长度不能超过 1024 个字符。
API中文描述
输入API的中文描述，说明API的功能等信息。
必填，可包含中文、英文、数字、特殊字符和空格，长度不能超过 1024 个字符。
API责任人
必填，选择服务的责任人。
维护人
非必填，选择服务的维护人。
所属领域
必填，选择服务所属领域，下拉可选值来源于的数据。
数据源
选择聚合服务实例数据所读取的实例数据库。
必填，仅可选在中，数据源定义“是否用于聚合服务”值为“是”的图数据库和关系型数据库。
此处选择图数据库类型。
是否纯脚本服务
根据已选数据源类型自动选择值，此处默认为“否”，暂不支持修改。
脚本类型
根据已选数据源类型自动选择脚本类型，此处默认“JavaScript”，暂不支持修改。
初始数据实体
图结构中的灵魂节点，一般是业务功能实现的核心节点，与多个节点存在关联关系。例如：Offering、Release。
必填，搜索关键字后下拉选择，可选值仅显示实例数据已入图的数据实体。
说明：仅非纯脚本服务才显示此参数。
支持服务运行结果保存为数据集
将API运行结果保存为数据集，后续可直接查表获取服务运行结果，无需再去调用API。
必填，支持选择“是”或“否”。如果选“是”，API发布成功后，您还需完成数据集配置。
服务权限信息
服务密级
API的密级。
必填，默认值为“内部公开”，暂不支持修改。
API调用方式
API调用方式
必填，下拉选择值。
- 前台同步调用：需考核接口响应时间。
- 非前台同步调用：不考核接口响应时间。
- 填写完后单击“保存并下一步”。
步骤2：添加与目标实体相关联的数据实体及关系
完成服务基本信息的填写后，非纯脚本服务通过编辑图结构，添加相关联的数据实体及关系，实现图形化编排数据模型的交互路径，系统会根据编排的图结构生成高效的查询脚本。
在编辑图结构阶段添加关联的数据实体及关系前，请确认目标服务已进入编辑状态。
以下步骤仅指导您如何在图结构中添加与目标实体相关联的数据实体及关系。如需了解更多编辑图结构的操作，详细请参考表2。
- 选择阶段，进入图结构编辑页面。
- 选中实体节点按鼠标右键，在调出的快捷菜单中单击“添加数据实体与关系”，弹出添加关联数据实体与关系窗口。
该弹窗列举显示了所有与选中实体相关联的数据实体和关系。
- 在添加数据实体&关系页签，勾选关联的数据实体和关系。
如需添加循环关系，请切换至“自循环关系”或“多数据实体循环关系”页签，根据模型的关联属性设置过滤条件。
在图结构中添加关联的数据实体和关系时，最多不允许添加超过2个运行态数据实体（如
）。图3 选择关联数据实体&关系。
- 单击“确定”保存。图谱中显示已添加实体节点及关系线。
- 单击“下一步”。
进入步骤3：新增入参阶段。
步骤3：新增入参
设置入参是指调用API时，设置需要传入的参数。系统提供默认入参参数，您还可根据需要通过自选入参和自定义入参方式新增入参参数。
|
参数 |
说明 |
|---|---|
|
pageSize |
必填，每页条目数，即每页显示的数据条目数。 |
|
pageNumber |
必填，分页页码，即返回指定页码的数据条目数。 |
|
returnTotalCountFlag |
是否返回数据条目总数。 |
以下步骤仅指导您如何通过自选入参方式新增入参参数。如需了解更多设置入参的操作，详细请参考表3。
设置入参前，请确认目标服务已进入编辑状态。
- 选择阶段，进入设置入参页面。
图4 设置入参
- 在左侧“设置入参”处选中数据实体，右侧展示该目标实体的属性列表，在列表中勾选入参属性。
- 在“入参汇总”处查看默认入参参数和已设置的入参参数，设置完入参后，单击“保存”。
- 完成入参设置后，单击“下一步”。
进入步骤4：新增过滤条件阶段。
步骤4：新增过滤条件
设置过滤条件是为在调用API时，缩小查询结果范围，只检索符合过滤条件的数据。当API接收到请求时，可以根据已设置的过滤条件，如日期、关键字、ID或其他用户定义的标准等参数过滤数据。对于返回大型数据集的API ，设置有效过滤可以显著提高性能，并减少需要通过网络传输的数据量。
设置过滤条件前，请确认目标服务已进入编辑状态。
以下步骤仅指导您如何新增过滤条件。如需了解更多设置过滤条件的操作，详细请参考表4。
- 选择阶段，进入设置过滤条件页面。
- 在图结构中选中实体或展开右侧“数据实体列表”后选中实体，新增过滤条件。
图5 设置过滤条件
- 单击“添加规则”，添加过滤条件。
- 添加过滤条件的属性。
- 添加过滤条件的匹配方式。
- 输入过滤条件。必填，不能以“\”开头结尾；“参数名称+逻辑符+参数值”不能重复，长度不超过128个字符。
如需设置多个数据实体的过滤条件均为某个入参，单击
，在“入参设置”弹窗中选择该属性要用作过滤条件的入参。 - 配置各过滤条件之间的关系：可选“与”和“或”。
- 设置完成过滤条件后，单击“保存”。
- 单击“下一步”。
进入步骤5：新增出参阶段。
步骤5：新增出参
出参是指调用API后返回给调用方的数据， 设置出参是指设置需要传出的参数。您可根据需要通过自选出参和自定义出参方式新增出参参数。
设置出参前，请确认目标服务已进入编辑状态。
以下步骤仅指导您如何通过自选出参方式新增出参参数。如需了解更多设置出参的操作，详细请参考表5。
- 选择阶段，进入设置出参页面。
- 在左侧“设置出参”处选中数据实体，右侧展示该目标实体的属性列表，在列表中勾选出参属性。
出参勾选非入图属性会生成一段脚本使用数据实体ID获取数据，ID如果自定义名称将失效。
如果有选择运行态数据实体（如
），且目标实体存在已发布的设备API映射（仅限批量接口），并勾选了设备API映射，后续进入服务开发阶段系统会自动生成图数据库查询和设备API调用脚本。
设置出参时，单个运行态数据实体只允许选择一个设备API映射。
图6 选择运行态数据实体的设备API映射
- 在“出参汇总”处查看已设置的出参，并配置出参信息。
表3 配置出参信息 类型
说明
自定义出参名称
自选出参方式新增的出参名称默认显示格式为{实体英文名称}_{属性名称}，支持修改。
是否自定义密级
非纯脚本服务的“是否自定义密级”均为“否”，且不支持修改。
数据实体/关系实体
属性归属的实体英文名称。
属性名称
属性英文名称。
出参密级
属性对应的密级。
描述
自选出参方式新增的出参默认显示属性对应的中文描述，支持修改。
数据类型
属性对应的类型。
聚合配置
对出参进行聚合配置，实现对数据表中的数据进行分组。
说明：未进行聚合配置的参数将默认为分组参数。
根据出参属性的数据类型不同，聚合配置项的可选类型有所不同。各类型代表含义如下：
- 平均值：表示数据分组后，计算并显示该属性列中所有值的平均值。
- 最大值：表示数据分组后，查找并显示该属性列的所有值中的最大值。
- 最小值：表示数据分组后，查找并显示该属性列的所有值中的最小值。
- 标准差：表示数据分组后，计算并显示该属性列的所有值的标准差。
- 总和：表示数据分组后，计算并显示该属性列的所有值的总和。
- 计数：表示数据分组后，统计并显示该属性列的所有值的条目数。
- 合并列表：表示数据分组后，列举显示该属性列的所有值（允许相同值出现）。
排序优先级
排序优先级总共1-10级，数字越小优先级越高，即1优先级最高，10最低，且不能重复。
说明：支持联合排序，最多可配置10个出参组合排序。
排序类型
可选升序或降序。
- 升序：将数据按照对应属性列升序排序。
- 降序：将数据按照对应属性列降序排序。
- 设置完出参后，单击“保存”。
继续参考步骤6：生成API。
步骤6：生成API
生成API是指完成服务定义后，保存服务定义信息并生成目标服务。
- 选择阶段，进入设置出参页面。
- 生成API时需区分不同的操作场景，具体如下。
- 如果是新增场景，请单击“生成API”。
- 如果是修改场景，请单击“部署”。
后续操作
完成以上步骤后，您可进入服务开发阶段，快速调测服务。
