创建服务编排API
按照业务逻辑,灵活的实现跨计算资源的多个API服务编排,简化服务之间组合调用的开发和运维成本,让应用开发人员更聚焦到业务实现,有效提高API的复用率。本文介绍如何创建服务编排API。
前提条件
操作步骤
步骤一:进入服务编排编辑器
登录数据资源平台控制台。
在页面左上角,单击
图标,选择协同。
在顶部菜单栏,单击
图标,选择目标工作组,单击资产加工。
在左侧导航栏,单击
图标,选择API开发 > 服务编排。
在API资源页面右上角,单击创建API。
步骤二:配置基础信息
在编辑器右侧,单击基础信息。
设置API的名称、所属应用、调用认证方式和描述等。
名称
说明
API名称
需创建API的名称,自定义。
所属应用
API的归属应用,自定义创建,支持在系统设置模块和创建API页面新增应用,关于新建应用,更多信息请参见新建应用。
API Path
API调用时展示的固定路径,默认自动生成。
调用认证方式
简单身份认证和加密身份认证两种方式,更多信息,请参见认证方式说明。
简单身份认证:适用于工作组内、测试等场景下的API调用,工作组内调用时用API归属应用的AppCode调用。
加密身份认证:通过加密算法计算一个签名并放在请求的Header中即可调用API,具备更高的安全性,适用于API共享后,应用开发场景下API的调用。
标签
自定义,可选。
描述
针对该API增加的描述信息,自定义,必选。
步骤三:设置流量控制
在编辑器右侧,单击流量控制。
根据实际需求,设置API最大调用次数、超时配置等。
说明如果开启了缓存,测试结果会缓存,当再次请求时,速度会更快。
步骤四:选择服务节点并配置节点属性
在左侧的服务节点列表,拖曳对应API至编辑器中。
编辑器的相关操作:
操作项
说明
放大
单击
图标,放大编辑器中的DAG。
缩小
单击
图标,缩小编辑器中的DAG。
居中
单击
图标,居中展示编辑器中的DAG。
自动布局
单击
图标,自动布局编辑器中的DAG。
保存草稿
单击
图标,保存未创建完成的服务编排API,以便后续继续配置。
全屏
单击
图标,进入全屏模式。按Esc按键退出全屏模式。
删除服务节点
选中需删除的服务节点,右击鼠标,单击弹出的删除。
删除连线
选中需删除的连线,右击鼠标,单击弹出的删除。
在节点属性面板,从选择API下拉列表中,选择需编排的API。
(可选)节点名称默认为选择的API的名称,可在节点名称文本框中删除原名称,输入所需节点名称。
按照上述操作,根据业务需求添加更多服务节点。
说明建议至少添加2个以上API。
步骤五:连接节点
将鼠标光标指向上游节点下部的圆圈。
当圆圈点亮时按下鼠标左键并拖拽到下游节点上部的圆圈上。
当下游节点上部的圆圈点亮时松开鼠标。
按照上述操作,完成需编排节点的所有连线。
步骤六:校验并保存
在编辑器顶部工具栏,单击
图标,弹出测试对话框。
单击开始测试,核对返回内容无误后,单击
图标,关闭测试对话框。
在编辑器顶部工具栏,单击
图标,完成服务编排API创建。
创建完成后,关闭编辑器页面,在API资源列表,可查看新建的API。
相关操作
API创建成功后的相关操作:
操作项 | 说明 |
编辑API | 在API资源列表中,单击目标API操作列的编辑,在API编辑向导页面,可对API进行编辑修改。 说明 编辑API参数配置中的云计算资源时,需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致,如果一致可能导致编辑完成后,编辑内容不生效。 |
复制API | 在API资源列表操作列,选择更多 > 复制,在API资源列表中生成一个新的草稿API。单击复制API操作列的编辑,对复制的API进行编辑修改。 |
删除API |
说明 已上线的API不支持删除。 |
后续步骤
API创建完成后,需要对API进行上线操作,具体操作,请参见上线API。