纯脚本服务定义
操作场景
聚合服务编排支持创建纯脚本服务,开发人员可直接开发脚本服务。
前提条件
已获取开发人员及以上权限用户的账号和密码。
步骤1:定义基本信息
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 单击“创建”,弹出“创建聚合服务”界面。
默认进入“服务定义”页的“基本信息”阶段。
- 根据界面提示,配置如下基本信息,如表1所示:
图2 创建纯脚本服务
表1 服务定义基本信息 参数
说明
基本信息
API英文名称
根据API提供的功能,自定义API的英文名称。
必填,不能重复,可包含字母、数字和英文半角“_”不能包含特殊字符,字首只能是大写字母,长度不能超过128个字符。
API中文名称
根据API提供的功能,自定义API的中文名称。
必填,不能重复,可包含中文、英文、数字和英文半角“-”“_”,长度不能超过 128 个字符。
API英文描述
输入API的英文描述,说明API的功能等信息。
必填,可包含英文、数字、特殊字符和空格,长度不能超过 1024 个字符。
API中文描述
输入API的中文描述,说明API的功能等信息。
必填,可包含中文、英文、数字、特殊字符和空格,长度不能超过 1024 个字符。
API责任人
必填,选择服务的责任人。
维护人
非必填,选择服务的维护人。
所属领域
必填,选择服务所属领域,下拉可选值来源于
的数据。数据源
选择聚合服务实例数据所读取的实例数据库。
必填,仅可选在“是否用于聚合服务”值为“是”的图数据库和关系型数据库。
中,数据源定义此处选择关系型数据库类型。
是否纯脚本服务
根据已选数据源类型自动选择值,此处默认为“是”,暂不支持修改。
脚本类型
根据已选数据源类型自动选择脚本类型,此处默认“SQL”,暂不支持修改。
支持服务运行结果保存为数据集
将API运行结果保存为数据集,后续可直接查表获取服务运行结果,无需再去调用API。
必填,支持选择“是”或“否”。如果选“是”,API发布成功后,您还需完成数据集配置。
服务权限信息
服务密级
API的密级。
必填,默认值为“内部公开”,暂不支持修改。
API调用方式
API调用方式
必填,下拉选择值。
- 前台同步调用:需考核接口响应时间。
- 非前台同步调用:不考核接口响应时间。
- 填写完后单击“保存并下一步”。
进入步骤2:新增入参阶段。
步骤2:新增入参
参数 |
说明 |
---|---|
pageSize |
必填,每页条目数,即每页显示的数据条目数。 |
pageNumber |
必填,分页页码,即返回指定页码的数据条目数。 |
returnTotalCountFlag |
是否返回数据条目总数。 |
设置入参前,请确认目标服务已进入编辑状态。
以下步骤仅指导您如何通过自定义入参方式新增入参参数。如需了解更多设置入参的操作,详细请参考表3。
步骤3:新增出参
出参是指调用API后返回给调用方的数据, 设置出参是指设置需要传出的参数。
设置出参前,请确认目标服务已进入编辑状态。
以下步骤仅指导您如何通过自定义出参方式新增出参参数。如需了解更多设置出参的操作,详细请参考表5。
步骤6:生成API
生成API是指完成服务定义后,保存服务定义信息并生成目标服务。
纯SQL脚本服务,可不生成API直接进入服务开发阶段。
- 选择 阶段,进入设置出参页面。
- 生成API时需区分不同的操作场景,具体如下。
- 如果是新增场景,请单击“生成API”。
- 如果是修改场景,请单击“部署”。
后续操作
完成以上步骤后,您可进入服务开发阶段,继续执行编辑脚本、运行脚本等操作,快速调测服务。