接口开发

操作流程

 

操作步骤

  1. 单击左侧导航树中的[应用集成/接口开发]菜单项。

  1. 在界面左上方选择后端服务对应的服务网关。

  1. 单击<新建>按钮，进入API编排设计器界面。在界面左边可以通过图形化界面对API接口进行编排，在界面右边配置接口属性信息。

  1. 以图形拖拽的方式进行无代码接口开发的过程。API编排设计器的布局及介绍，详见下图。

  1. 单击<保存>按钮，保存已编排的应用。

  1. 应用编排好后，单击右上方<调试>按钮，调试集成应用。单击右上方的<校验>按钮，对编排进行校验。

  1. 单击<导入>按钮，可以导入JSON格式写好的编排文件。导入文件会覆盖当前数据预览，请谨慎操作！

  1. 单击<保存>按钮，保存已编排的应用。然后单击<关闭>按钮，关闭API编排设计器。

  1. 在接口开发页面，单击<发布到网关>，将接口注册发布到服务网关。

API编排设计器

图-1 API编排设计器布局

 

表-1 API编排设计器区域说明

区域

说明

工具区

包括编排区域缩放、调试、保存，图片下载、检验、导入和关闭等功能。

图元区

图元算子列表。编排时直接将对应图元拖动到编排区，定义其属性。包含如下两类图元：

  • 后端服务API：用于描述不同的后端服务API图元。

  • 逻辑图元：用于描述模板执行逻辑的图元。包括赋值图元、决策图元、等待图元、循环图元、跳出循环图元和脚本图元。

编排区

服务编排的设计操作区域。将图元拖到编排区进行编排。

配置区

接口或单个图元的属性配置。

  • 接口属性：单击编排区，弹出接口属性窗口。可定义接口的基础配置、全局上下文和数据预览等。

  • 图元属性：图元拖入编排区后，单击图元，弹出图元属性配置窗口。不同图元可配置的属性不同。

 

图元属性

1.      API图元属性

将API编辑器的图元拖拽到界面中，单击该图元，可以在界面右边对图元属性进行编辑。

属性

说明

基本信息

名称

自定义API名称，支持中文、英文字母、数字和特殊字符“.”，“-”，“_”，以英文字母或中文开头，长度1到64个字符。

描述

自定义描述，0-128个字符。

配置信息

后端服务

选择后端服务。

API数据

在选择了后端服务后，此处将显示后端服务对应的API条目可供选择。

路径

API所在路径。

请求方法

选择的API定义的请求方法。

入参/出参

不同的请求方式，对应不同的入参和出参。

重试次数

设置访问该API的重试次数，超过次数即认为不可达。

超时时间

设置访问该API的超时时间，默认为60。

超时时间单位

设置访问该API的超时时间单位，默认为秒。

 

2.      赋值图元属性

您可以对流程中使用的变量等进行赋值。变量和值支持从全局上下文中选择，也可以手动输入。

属性

说明

基本信息

名称

自定义名称，支持中文、英文字母、数字和特殊字符“.”，“-”，“_”，以英文字母或中文开头，长度1到64个字符。

描述

0-128个字符。

配置信息

按照界面信息，可以选择上下文或者自定义的方式进行配置。

提示在填写完配置信息后，需要单击下面的<添加>按钮，才能完成配置的下发。

 

3.      决策图元属性

通过决策图元，可以根据上下文常量或变量定义多个条件分支，以支持不同情况的业务走向。

属性

说明

名称

自定义名称，支持中文、英文字母、数字和特殊字符“.”，“-”，“_”，以英文字母或中文开头，长度1到64个字符。

描述

0-128个字符。

配置信息

  • 添加分支

1.     单击<添加分支>按钮，下方弹出分支属性框。可以单击<增加条件>，进入配置分支条件对话框。

2.     输入分支名称，单击<增加条件>按钮，在界面上输入条件，可以选择全局常量、变量进行配置。

3.     单击<清除全部>按钮，可以清除所有的条件。

4.     单击<确定>按钮完成操作。

  • 删除分支：单击<删除>按钮，可以删除该分支。

提示最多可以添加11个分支。系统中缺省有Default分支和true分支供选择。

 

4.      循环图元属性

循环图元用于处理有循环需求的流程，在循环中可以引入其他图元，如赋值，决策等。每次循环即对循环对象进行一次遍历，将循环对象的当前值赋值给迭代遍历。

属性

说明

名称

自定义名称，支持中文、英文字母、数字和特殊字符“.”，“-”，“_”，以英文字母或中文开头，长度1到64个字符。

描述

0-128个字符。

配置信息

  • 循环对象：从全局变量中选择数组。

  • 迭代变量：从全局变量中选择变量。

  • 遍历顺序：可以选择升序或者降序。

 

5.      跳出循环图元属性

通过终止循环图元，您可以选择要终止的循环。该图元须与循环图元配合使用。

属性

说明

名称

自定义名称，支持中文、英文字母、数字和特殊字符“.”，“-”，“_”，以英文字母或中文开头，长度1到64个字符。

描述

0-128个字符。

跳出循环

选择需要跳出的循环名称。

 

6.      等待图元属性

通过等待图元，您可以定义等待偏移时长。

属性

说明

名称

自定义名称，支持中文、英文字母、数字和特殊字符“.”，“-”，“_”，以英文字母或中文开头，长度1到64个字符。

描述

0-128个字符。

配置信息

  • 等待时长：设置等待时长。

  • 单位：设置等待时长的单位。

 

7.      脚本图元属性

通过脚本图元，您可以灵活自定义脚本实现相应逻辑。支持JavaScript脚本，编写时可以参考脚本指南。

属性

说明

名称

自定义名称，支持中文、英文字母、数字和特殊字符“.”，“-”，“_”，以英文字母或中文开头，长度1到64个字符。

描述

0-128个字符。

配置信息

脚本内容，可以参考脚本样例和脚本指南进行编写。

 

接口属性

1.      基础配置

参数

说明

名称

自定义接口在本系统的显示名称，策略绑定接口、订阅服务时需通过此名称选择本接口。

描述

自定义接口描述。

接口信息

起始图元

选择API图元作为编排的第一个对象。

方法

可以是GET或者POST。

入参

  • Header：入口参数的头函数

  • Query：入口参数的请求函数

出参

出口参数。

 

2.      全局上下文

  1. 单击<添加变量>按钮，弹出添加变量对话框。

  1. 输入各项参数，单击<确定>按钮完成操作。

  1. 单击<添加全局变量>按钮，弹出添加全局变量对话框。

  1. 输入各项参数，单击<确定>按钮完成操作。

参数

说明

名称

自定义变量名称。

数据类型

包括文本、数字、整数、布尔、数组和对象类型。

默认值

确定默认值。

描述

自定义变量的描述。

 

3.      数据预览

在完成了全局上下文的变量配置后，单击“数据预览”页签，可以看到设置的数据信息。