快速入门

# 快速入门

本文档描述使用ASGP产品快速入门的流程，默认登录账户已完成系统配置。分为服务提供方和服务消费方的两个视角进行快速入门说明。

# 服务提供方

# 登录

输入正确的用户名密码验证码，即可进入主页

login

# SSL证书管理

路径：【系统管理-资源管理-SSL证书管理】

# 证书列表

cert-list

证书列表提供以下功能：查询、新增、查看、编辑、key证书下载、crt证书下载、删除。

查询：对已经维护的证书进行查询、搜索，搜索条件包含名称、证书IP、生效状态。

名称：文本框输入，支持模糊查询，

证书IP：文本框输入，支持模糊查询，

生效状态：下拉列表查询，包含“生效”、“失效”两种类型，

点击右上角”筛选“按钮，可展开/收起查询条件区域。

点击“重置”按钮，可重置条件进行查询。

# 新增证书

cert-add

点击“新增”按钮，打开新增证书的弹框界面。

需要填写名称、上传crt文件、上传key文件、证书IP、有效期、描述。

名称：必填项。且唯一。

cert-add2

上传crt文件：必填项。单文件上传。需要上传.crt类型的文件。 如果上传的crt文件IP地址已存在，则上传失败。

上传key文件： 必填项。单文件上传。需要上传.key类型的文件。 必须先上传crt文件，再上传key文件。

证书IP：不可编辑。crt文件上传成功后自动带出IP。

有效期：不可编辑。crt文件上传成功后自动带出有效期。 证书过期后，接口也可以正常调用，只是浏览器会提示证书过期。

描述：非必填。

# 引擎管理

路径：【系统管理-资源管理-引擎管理】

# 引擎列表

engine-list

引擎列表的过滤条件：列表中展示的引擎是当前登陆账户所在本级组织及下级组织的引擎。

引擎列表提供以下功能：查询、新增服务引擎、查看、编辑、设置、删除。

查询：对已经维护的引擎进行查询、搜索，搜索条件包含名称、状态、IP地址、http端口、https端口、类型。

名称：文本框输入，支持模糊查询，

状态：下拉列表查询，包含“在线”、“离线”两种状态，

IP地址：文本框输入，支持模糊查询，

http端口：数字框输入，支持模糊查询，

https端口：数字框输入，支持模糊查询，

类型：下拉列表查询，包含“服务引擎”、“交换引擎”、“AESB引擎”三种类型，

点击右上角”筛选“按钮，可展开/收起查询条件区域。

点击“重置”按钮，可重置条件进行查询。

# 新增服务引擎

engine-add

点击“新增服务引擎”按钮，打开新增引擎的弹框界面。

需要填写名称、IP地址、http端口、https端口、适用组织范围、描述。

名称：必填项。且唯一。

IP地址：必填项。设置引擎的IP地址。

engine-add2

http端口：必填项。设置引擎的http端口。 输入IP地址和http端口后，点击“测试连接”，可测试连接是否成功。连接失败也能保存引擎。

https端口：必填项。设置引擎的http端口。 输入IP地址和https端口后，点击“测试连接”，可测试连接是否成功。连接失败也能保存引擎。

适用组织范围：必填项。至少勾选一个组织。设置引擎的适用组织范围。 组织树列表展示的是当前登陆账户所属组织及其下级到叶子结点的所有组织。组织树默认展开所有节点。

描述：非必填。

新增引擎时候，后台会自动监测证书是否存在，不存在，提示：请先在证书管理中上传ssl证书后再注册引擎。

# 应用管理

路径：【系统管理-资源管理-应用管理】

# 应用列表

app-list

应用列表的过滤条件：按照应用的集成负责人属性进行过滤。

应用列表提供以下功能：查询、新增、查看、编辑、设置、删除。

查询：对已经维护的应用进行查询、搜索，搜索条件包含名称、应用简称、保密等级、变更人、变更时间。

名称：文本框输入，支持模糊查询，

应用简称：文本框输入，支持模糊查询，

保密等级：下拉列表查询，包含“无”、“秘密”、“机密”、“绝密”四种类型，

变更人：文本框输入，支持模糊查询，

变更时间：时间框选择范围，

点击右上角”筛选“按钮，可展开/收起查询条件区域。

点击“重置”按钮，可重置条件进行查询。

# 新增应用

app-add

点击“新增”按钮，打开新增应用的弹框界面。

需要填写应用名称、应用简称、AppCode、保密等级、集成主管组织、集成负责人、描述。

应用名称：必填项。且唯一。

应用简称：必填项。且唯一。

AppCode： 必填项。

保密等级：必填项。 在API申请时候，保密等级低的应用不可以申请保密等级高的应用API

集成主管组织：必填项。下拉框展示完整组织树。

集成负责人：必填项。 1.创建者是默认的应用的集成负责人。 2.每个应用至少有一个集成负责人。 3.集成负责人不能删除自己，但是可以删除其他的集成负责人。 4.集成负责人在应用列表中可以看到其所在的应用列表。可否对应用进行删改操作根据集成负责人所拥有的功能限权限确定 5.集成负责人可以从全部组织中选择（左侧穿梭框），右侧穿梭框显示的是本应用的全部集成负责人 6.集成负责人在创建时候，只能创建自己所负责的应用下的API 7.如果人员转移到其他组织后，管理职责不变

描述：非必填。

# 数据源管理

路径：【系统管理-资源管理-数据源管理】

# 数据源列表

dataSource/select

数据源列表的过滤条件：按照应用的集成负责人属性进行过滤。

数据源列表提供以下功能：查询、新增、编辑、删除、查看、启用、暂停。

查询：

数据源名称：文本框输入，支持模糊查询

数据库名称：文本框输入，支持模糊查询，

数据库类型：下拉列表查询，包含MySql、Oracle、DM8，

所属应用：下拉列表查询，根据当前用户是应用集成管理员做过滤，显示该用户为应用集成管理员的全部应用，

状态：下拉列表查询，包含已启用、已暂停。

# 新增数据源

dataSource/add

数据源名称，需要填写所属应用、服务名称、服务协议、开放类型、请求方法。

所属应用：必填项。根据当前用户是应用管理员进行过滤。

业务主管组织：非必填。选择所属应用时自动填值，不允许手动填值。

集成主管组织：非必填。选择所属应用时自动填值，不允许手动填值。

交换用途：非必填。XXXXXXXXXXXXXXXXX。

数据库类型：必填项。包含MySql、Oracle、DM8。

数据库ip地址：必填项。

数据库端口：必填项。

数据库名称：必填项。

数据库用户名：必填项。

数据库密码：必填项。测试连接是测试数据库是否可用，点击时，会检验 数据库类型、数据库ip地址、数据库端口、数据库名称、数据库用户名、数据库密码的值。

schema:数据库类型为Oracle、DM8,才会显示，且为必填项

描述：非必填。

# 启用数据源

dataSource/start

# 后端资源

路径：【服务集成-服务管理-后端资源】

# 后端资源列表

backendService/select

后端资源列表的过滤条件：按照应用的集成负责人属性进行过滤。

后端资源列表提供以下功能：查询、新增、编辑、删除、查看、导入。

服务名称：文本框输入，支持模糊查询。

开放类型：下拉列表查询，包含RESTFUL、WEBSERVICE。

服务地址：文本框输入，支持模糊查询。

所属应用：下拉列表查询，根据当前用户是应用集成管理员做过滤，显示该用户为应用集成管理员的全部应用。

# 后端资源新增

backendService/add

新增一条后端资源,分为3步，服务定义、服务设计、响应示例。

流程按钮 说明
取消 返回服务列表。
上一步 返回上一个操作步骤。
下一步 会校验当前填写信息是否正确，校验通过进入下一个操作步骤。
暂存 不校验必填，暂时保存到服务列表中，状态为“已暂存”。
保存 校验所有填写信息是否正确，校验通过，保存数据，状态为“已保存”

新增-服务定义

backendService/addDefineRestful backendService/addDefineWebService

所属应用：必填项。根据当前用户是应用管理员进行过滤。默认选中应用列表中第一个应用。

服务名称：必填项。平台内全部服务名称校验唯一。

服务协议：必填项。HTTP、HTTPS。

开放类型：必填项。RESTFUL、WEBSERVICE。

  • RESTFUL：
    • 请求方法：必填项。GET、POST、PUT、DELETE。
  • WEBSERVICE：
    • 请求方法：必填项。OPERATION。
    • 命名空间:必填项。

描述：非必填项。填写该服务的业务描述。

新增-服务设计

backendService/addDeSignRestful

服务地址：必填项。输入合法地址，会自动解析出相应path参数和params参数。

backendService/addDeSignRestful1

参数定义：包含headers path params authorization body。其中authorization为安全认证方式，包含APIKey、BasicAuth、BearerToken。

参数项 描述
headers参数 1.用户自定义headers参数，允许新增、删除、编辑。需要定义参数名、参数类型、是否必填、最大长度、默认值、示例值、描述。
2.客户端流水号信息，均不可编辑。
path参数 根据填写的服务地址自动识别path参数，不允许新增、删除，可以编辑参数类型、是否必填、最大长度、默认值、示例值、描述。
params参数 根据填写的服务地址自动识别params参数，不允许新增、删除，可以编辑参数类型、是否必填、最大长度、默认值、示例值、描述。
body参数 根据用户实际需求可以切换参数格式：none、form-data、x-www-form-urlencoded、json、obj-array、binary。
**none：**无需编辑body参数。
**form-data：**根据用户需新增参数，headers中默认增加一条参数：Content-Type= application/form-data的数据。body参数手动新增，新增包含参数名、参数类型、是否必填、最大长度、默认值、示例值、描述。
**x-www-form-urlencoded：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/x-www-form-urlencoded的数据。body参数手动新增，新增包含参数名、参数类型、是否必填、最大长度、默认值、示例值、描述。
**json：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/json的数据。json中输入样式是左侧输入框，右侧表格，在输入框内输入json，点击提取数据，自动在右侧表格生成参数。可以编辑参数类型、是否必填、最大长度、默认值、描述，不允许编辑参数名、示例值。
**obj-array：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/json(array)的数据。obj-array中输入样式是json输入框。
**binary：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/octet-stream的数据。

backendService/addDeSignRestful4

authorization:

安全认证 说明
无认证 无认证
BasicAuth basic认证，参数会定义在headers中,会被base64加密
BearerToken bearer认证,参数会定义在headers
APIKey 自定义key:value类型,参数会定义在headers或params中

新增-响应示例

backendService/addResp

响应格式:必填项。json和xml。

成功响应示例:非必填项。

失败响应示例:非必填项。

# 服务列表

路径：【服务集成-服务管理-服务列表】

服务集成提供全生命周期的API管理，从服务定义、服务设计、服务开发、服务测试、服务发布，到服务治理策略配置、共享中心申请，实现完整的API解决方案。帮助您轻松管理和部署API。

# 服务列表

selectlist

服务列表的过滤条件：根据当前用户是应用集成管理员进行过滤，如果用户是某应用的集成管理员，则可以查看该应用下的全部服务。

服务列表提供以下功能：查询、新增库表服务、新增代理服务、新增编排服务、导出、查看、编辑、删除、测试、发布、灰度发布、灰度策略、启动、暂停、卸载、复制、快捷设置、token管理、文档预览。

查询：对已经维护的服务进行查询、搜索，搜索条件包含服务名称、服务类型、开放类型、数据状态、所属应用。

服务名称：文本框输入，支持模糊查询，

服务类型：下拉列表查询，服务类型包含代理服务、库表服务、编排服务，

开放类型：下拉列表查询，开放类型包含RESTful和WebService，

服务状态：下拉列表查询，数据状态包含暂存、待测试、测试通过、已发布、已卸载

所属应用：下拉列表查询，根据当前用户是应用集成管理员做过滤，显示该用户为应用集成管理员的全部应用。

点击右上角”筛选“按钮，可展开/收起查询条件区域。

点击“重置”按钮，可重置条件进行查询。

# 服务生命周期

workflow

不论是新增数据库服务、新增代理服务、新增编排服务都遵循这个生命周期：

1.0版本

**新增/编辑：**点击新增即打开对应的新增页面，填写信息点击暂存按钮，服务状态为暂存状态，可以再次编辑，点击保存后，服务状态为待测试状态，待测试状态的数据还可以进行编辑。

**测试：**待测试状态的数据允许进行测试，测试未通过，服务状态仍为待测试状态，可以多次进行测试，测试通过后，服务状态修改为测试通过状态。测试通过状态的数据还可以进行编辑，保存后变为待测试状态。

**发布：**测试通过状态的数据可以进行发布，发布后该服务正式提供服务，服务信息同步到API共享中心里，提供申请，下载使用指南。当下服务状态为已发布状态。已发布状态的数据可用状态默认为已启用，可以通过按钮控制该服务的启动、暂停。

**卸载：**已发布状态的数据可以进行卸载，服务状态变更为已卸载状态。已卸载的服务在共享中心可以查看，但不再提供申请。

2.0版本

**灰度发布：**当服务已经发布或卸载，要进行版本编辑或升级时，点击灰度发布后，打开灰度发布编辑页面，保留1.0版本的全部数据，服务名称、应用、访问地址不可编辑，其他字段可编辑，暂存、保存、测试、发布操作同1.0版本。仅支持对已发布和已卸载状态的进行灰度发布。如果该服务已经有一个灰度发布版本正在暂存状态、待测试状态、测试通过状态、已发布状态，则该服务不能够再次进行灰度发布，一个服务同时仅支持灰度发布一个版本。2.0版本现在发布为灰度发布，暂时没有申请接入访问。

**灰度策略：**对灰度发布的版本，从已申请该服务的全部应用中，选择某一个或某几个应用邀请进行灰度版本访问，支持灰度回退，支持灰度版本发布为正式版本。

灰度策略未设置访问应用时，申请者无法访问到灰度版本，灰度版本可以进行卸载操作。

灰度策略设置为选中某几个应用时，从1.0版本引流到2.0版本，应用访问的是灰度版本。现在灰度版本不允许卸载，只有当灰度策略回退为未设置访问应用才允许卸载。

灰度策略设置为全部应用时，该灰度版本正式切换为正式发布，服务信息同步到API共享中心里，提供申请，下载最新版本使用指南。

服务表单界面相关流程按钮说明：

流程按钮 说明
取消 返回服务列表。
上一步 返回上一个操作步骤。
下一步 会校验当前填写信息是否正确，校验通过进入下一个操作步骤。
暂存 不校验必填，暂时保存到服务列表中，状态为“暂存”。
暂存并下一步 会校验当前填写信息是否正确，校验通过，暂时保存到服务列表中，状态为“暂存”。同时进入下一个步骤。
保存 校验所有填写信息是否正确，校验通过，保存到服务列表中，状态为“待测试”。

# 新增代理服务

使用场景：将第三方接口代理为新的服务，服务协议转换、增加超时控制、增加安全认证、支持缓存、扩展服务地址、对第三方接口进行流量控制、黑白名单控制等需求的处理。

点击“新增代理服务”按钮，进入新增代理服务页面。服务完整生命周期一共五个步骤，分别分为服务定义、服务设计、服务开发、服务测试、服务发布。在新增页面，对服务定义、服务设计、服务开发的内容进行编辑并保存。

服务定义

addProxyService/add1

服务定义，需要填写服务名称、版本、应用、标签、业务领域、描述，定义该服务的基本信息。

服务名称：必填项。平台内全部服务名称校验唯一。

服务版本：必填项。不可编辑，系统自动生成。

addProxyService/add1

应用：必填项。根据当前用户是应用管理员进行过滤。默认选中应用列表中第一个应用。如果后面选过后端资源了，切换应用会将选过的后端资源清空。

addProxyService/add1

标签：非必填项。可以自定义标签（输入标签名称，点击“添加标签”按钮生成）、或选择平台内已有标签（输入标签名称，在下拉列表选中）。

业务领域：必填项。选择业务领域。

描述：非必填项。填写该服务的业务描述。

服务设计

addProxyService/add2

服务设计，需要填写服务协议、开放类型、超时时间、支持缓存、安全认证，定义该服务的网关业务属性。

服务协议：必填项。当前新增的服务是http协议、https协议，或者同时发布两个接口。

开放类型：必填项。当前新增的服务是restful接口还是webservice接口。如果选择restful接口，服务开发中选择的后端资源会过滤restful类型的接口。

超时时间：必填项。针对代理的后端资源进行超时时间控制。

支持缓存：必填项。默认是否，如果选择是，则填写缓存时间。

安全认证：必填项。无认证、BASIC认证、动态TOKEN认证、固定TOKEN认证、APIKEY认证。

安全认证 说明
无认证 服务不需要认证
BASIC认证 服务访问需要通过BASIC认证，在ASGP中定义BASIC的用户名和口令，传参位置在headers
动态TOKEN认证 服务访问需要通过动态TOKEN认证，ASGP系统在用户申请通过后会生成动态TOKEN的请求访问地址，通过消息中心获取地址，每次服务访问前获取最新的动态TOKEN。
固定TOKEN认证 服务访问需要通过固定TOKEN认证，ASGP系统在用户申请通过后会生成固定TOKEN，通过消息中心获取。
APIKEY认证 服务访问需要通过APIKEY认证，在ASGP中定义suuid和appuuid

服务开发

addProxyService/add3

服务开发，需要后端资源所属应用、后端资源名称、代理服务地址、成功响应示例、失败响应示例，选择代理该服务的后端资源，该后端资源选中后，可以通过展开收起查看该后端资源的详细信息，自动带出后端资源的服务地址、响应示例格式、成功响应示例和失败响应示例。

后端资源所属应用：根据服务定义中的所属应用，自动带出后端资源所属应用，不可编辑。

后端资源名称：根据后端资源所属应用和服务设计中的开放类型过滤系统中的后端资源，选中一个进行代理。

代理服务地址：分为两个部分，第一部分由用户自定义，第二部分由后端资源名称选中后，自动带出，不可编辑。

响应示例格式：由后端资源名称选中后，自动带出，不可编辑。

成功响应示例：由后端资源名称选中后，自动带出，不可编辑。

失败响应示例：由后端资源名称选中后，自动带出，不可编辑。

addProxyService/add3

服务保存成功后，可选择返回列表、进入测试、继续编辑。

# 新增编排服务

使用场景：将多个第三方接口编排为一个新的服务，统一入口，通过传递不同的参数访问不同的后端资源。并且支持对新编排产生的服务进行服务协议转换、增加超时控制、增加安全认证、支持缓存、扩展服务地址、对第三方接口进行流量控制、黑白名单控制等需求的处理。

点击“新增编排服务”按钮，进入新增代理服务页面。服务完整生命周期一共五个步骤，分别分为服务定义、服务设计、服务开发、服务测试、服务发布。在新增页面，对服务定义、服务设计、服务开发的内容进行编辑并保存。

服务定义

addLayoutService/add1

服务定义，需要填写服务名称、版本、应用、标签、业务领域、描述，定义该服务的基本信息。

服务名称：必填项。平台内全部服务名称校验唯一。

服务版本：必填项。不可编辑，系统自动生成。

应用：必填项。根据当前用户是应用管理员进行过滤。默认选中应用列表中第一个应用。如果后面选过后端资源了，切换应用会将选过的后端资源清空。

标签：非必填项。可以自定义标签（输入标签名称，点击“添加标签”按钮生成）、或选择平台内已有标签（输入标签名称，在下拉列表选中）。

业务领域：必填项。选择业务领域。

描述：非必填项。填写该服务的业务描述。

服务设计

addLayoutService/add2

服务设计，需要填写服务协议、开放类型、请求地址、请求方法、超时时间、支持缓存、入参定义，定义该服务的网关业务属性。

服务协议：必填项。当前新增的服务是http协议、https协议，或者同时发布两个接口。

开放类型：必填项。当前新增的服务是restful接口还是webservice接口。 1.如果选择webservice接口，服务开发中选择的后端资源会过滤webservice类型的接口。因为开放类型是webservice的服务只能和webservice类型的后端资源做映射，restful类型的服务和restful、webservice类型的后端资源都能做映射。 2.切换开放类型，会清空服务开发中已选中的后端资源。

addLayoutService/add2

请求地址：必填项。定义当前新增的服务的访问地址。入参定义会根据地址解析出相应path参数和params参数。

请求方法：必填项。定义当前新增的服务的请求方法。默认是get请求。 1.如果设置为get请求，入参定义可设置params参数，无法设置body参数。 2.如果设置为post、put、delete请求，入参定义可以设置body参数，无法设置params参数。

超时时间：必填项。针对代理的后端资源进行超时时间控制。

支持缓存：必填项。默认是否，如果选择是，则填写缓存时间。

入参定义中，包含authorization、headers、path、params、body参数。authorization为安全认证参数，定义该服务的认证参数，包含无认证、BASIC认证、动态TOKEN认证、固定TOKEN认证、APIKEY认证。APIKEY认证可以根据用户实际需要选择认证参数的位置，可以选headers和params，定义的认证参数不可修改。

安全认证 说明
无认证 服务不需要认证
BASIC认证 服务访问需要通过BASIC认证，在ASGP中定义BASIC的用户名和口令，传参位置在headers，并使用base64加密
动态TOKEN认证 服务访问需要通过动态TOKEN认证，ASGP系统在用户申请通过后会生成动态TOKEN的请求访问地址，通过消息中心获取地址，每次服务访问前获取最新的动态TOKEN。
固定TOKEN认证 服务访问需要通过固定TOKEN认证，ASGP系统在用户申请通过后会生成固定TOKEN，通过消息中心获取。
APIKEY认证 服务访问需要通过APIKEY认证，在ASGP中定义suuid和appuuid

addLayoutService/add2

addLayoutService/add2

信息项 描述
headers参数 1.用户自定义headers参数，允许新增、删除、编辑。需要定义参数名、参数类型、是否必填、最大长度、默认值、示例值、描述。
2.客户端流水号信息，均不可编辑。
path参数 根据填写的服务地址自动识别path参数，不允许新增、删除，可以编辑参数类型、是否必填、最大长度、默认值、示例值、描述。
params参数 根据填写的服务地址自动识别params参数，不允许新增、删除，可以编辑参数类型、是否必填、最大长度、默认值、示例值、描述。
body参数 根据用户实际需求可以切换参数格式：none、form-data、x-www-form-urlencoded、json、obj-array、binary。
**none：**无需编辑body参数。
**form-data：**根据用户需新增参数，headers中默认增加一条参数：Content-Type= application/form-data的数据。body参数手动新增，新增包含参数名、参数类型、是否必填、最大长度、默认值、示例值、描述。
**x-www-form-urlencoded：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/x-www-form-urlencoded的数据。body参数手动新增，新增包含参数名、参数类型、是否必填、最大长度、默认值、示例值、描述。
**json：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/json的数据。json中输入样式是左侧输入框，右侧表格，在输入框内输入json，点击提取数据，自动在右侧表格生成参数。可以编辑参数类型、是否必填、最大长度、默认值、描述，不允许编辑参数名、示例值。
**obj-array：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/json(array)的数据。obj-array中输入样式是json输入框。
**binary：**根据用户需新增参数，headers中默认增加一条参数：Content-Type=application/octet-stream的数据。

服务开发

addLayoutService/add2

进入服务开发，可以看到画布上有一组默认路由节点。画布具有如下功能：
1.新增路由：点击“新增路由”，会在顶部新增一组路由节点：路由-->后端资源-->参数映射-->响应示例。
2.删除路由：鼠标单击选中某一组路由的某个节点，点击“删除路由”按钮，会删除这一组节点。默认路由不可删除。
3.上移路由：鼠标单击选中某一组路由的某个节点，点击“上移路由”按钮，会上移这一组节点。默认路由不可上移。
4.下移路由：鼠标单击选中某一组路由的某个节点，点击“下移路由”按钮，会下移这一组节点。默认路由不可下移。
5.显示缩略图：打开“显示缩略图”开关，会展示画布缩略图。缩略图上可通过矩形框移动画布位置，画布上路由较多时，用缩略图较方便。
画布灰色节点不可编辑，蓝色节点可进行双击编辑。

编排服务的服务开发，进入画布页面，有一条默认路由，需要用户选择该条路由的后端资源、对服务设计中的入参定义和后端资源的参数进行参数映射、根据后端资源自动带出响应示例。

addLayoutService/add2

路由：默认路由不可编辑，新增的路由可以双击路由节点打开弹窗编辑。可编辑路由名称、匹配方式、路由条件。 1.路由名称：必填项。会按照规则自动生成路由名称，也可自定义路由名称。 2.匹配方式：必填项。可以设置下面的路由条件如何匹配。“满足任意条件”或“满足全部条件”。 3.路由条件：必填项，至少有一条路由条件。通过“添加”和“删除”按钮，增删路由条件。

路由条件 说明
条件来源 条件来源固定是HEADER和PARAMS。
参数名称 选中条件来源后，参数名称下拉列表根据条件来源过滤上一步服务定义中入参定义的参数。
参数类型 选中参数名称后，参数类型自动带出不可编辑。
条件类型 选中参数名称后，条件类型下拉列表根据参数类型过滤。
1.参数类型是字符串，条件类型可选：等于、不等于、包含。
2.参数类型是数值，条件类型可选：等于、不等于，大于，大于等于，小于，小于等于。
3.参数类型是布尔值，条件类型可选：等于、不等于。
条件值 设置的条件值。多个条件值可用英文逗号间隔区分枚举值。

addLayoutService/add2

addLayoutService/add2

后端资源：双击"后端资源"节点打开弹窗，根据后端资源应用过滤系统中的后端资源，选中一个进行编排，不区分restful服务或者webservice服务。如果选中的后端资源是webservice类型，必须要选择相应的operation，才可进行编排。后端资源选中后，会将服务协议、开放类型、请求方法、请求路径、命名空间带出。

addLayoutService/add2

参数映射：双击"参数映射"节点打开弹窗。对服务设计中的入参定义和后端资源的参数进行参数映射，通过手动连线或自动映射的方式，将入参参数和后端资源的参数进行关联。入参参数可以映射给多个后端资源的参数，但是一个后端资源的参数不能同时和多个入参参数关联。 自动映射的规则是参数、参数类型相同，可以实现自动连线。 后端参数有必填、无默认值的必须连线。

addLayoutService/add2

响应示例：双击"响应示例"节点打开弹窗。由后端资源名称选中后，自动带出，不可编辑。

服务保存成功后，可选择返回列表、进入测试、继续编辑。

# 新增库表服务

点击“新增库表服务”按钮，进入新增库表服务页面。服务完整生命周期一共五个步骤，分别分为服务定义、服务设计、服务开发、服务测试、服务发布。在新增页面，对服务定义、服务设计、服务开发的内容进行编辑并保存。

服务定义

addDBService/add1

服务定义，需要填写服务名称、版本、应用、标签、业务领域、描述，定义该服务的基本信息。

服务名称：必填项。平台内全部服务名称校验唯一。

服务版本：必填项。不可编辑，系统自动生成。

应用：必填项。根据当前用户是应用管理员进行过滤。默认选中应用列表中第一个应用。如果后面选过数据源信息了，切换应用会将选过的数据源信息清空。

addDBService/add1

标签：非必填项。可以自定义标签（输入标签名称，点击“添加标签”按钮生成）、或选择平台内已有标签（输入标签名称，在下拉列表选中）。

业务领域：必填项。选择业务领域。

描述：非必填项。填写该服务的业务描述。

服务设计

addDBService/add2

服务设计，需要填写服务协议、请求地址、请求方法、超时时间、支持缓存、安全认证。

服务协议：必填项。当前新增的服务是HTTP协议、HTTPS协议，或者HTTP和HTTPS。

请求地址：必填项。定义当前新增的服务的访问地址。

请求方法：必填项。定义当前新增的服务的请求方法。默认是get请求。 1.如果设置为GET请求，入参定义可设置params参数，无法设置body参数。 2.如果设置为POST请求，入参定义可以设置body参数，无法设置params参数。

超时时间：必填项。针对库表的后端资源进行超时时间控制。

支持缓存：必填项。默认是否，如果选择是，则填写缓存时间。

安全认证参数，包含无认证、BASIC认证、动态TOKEN认证、固定TOKEN认证、APIKEY认证。APIKEY认证可以根据用户实际需要选择认证参数的位置，可以选headers和params，定义的认证参数不可修改。

安全认证 说明
无认证 服务不需要认证
BASIC认证 服务访问需要通过BASIC认证，在ASGP中定义BASIC的用户名和口令，传参位置在headers，并使用base64加密
动态TOKEN认证 服务访问需要通过动态TOKEN认证，ASGP系统在用户申请通过后会生成动态TOKEN的请求访问地址，通过消息中心获取地址，每次服务访问前获取最新的动态TOKEN。
固定TOKEN认证 服务访问需要通过固定TOKEN认证，ASGP系统在用户申请通过后会生成固定TOKEN，通过消息中心获取。
APIKEY认证 服务访问需要通过APIKEY认证，在ASGP中定义suuid和appuuid

addDBService/add2

addDBService/add2

服务开发

addDBService/add2

addDBService/add3-1

服务开发，需要选择数据源、发布方式、选择引擎、选择表/视图、单次查询返回总数、请求参数、返回参数、成功相应示例、失败相应示例。

选择数据源：必填项。

addDBService/add3-2

发布方式：

单表发布，需要填写选择引擎，选择表视图，单词查询返回总数

addDBService/add3-3

SQL发布，需要必填SQL语句

addDBService/add3-4

选择引擎：

addDBService/add3-5

选择表/视图：

addDBService/add3-6

单次查询返回总数：分为全部和自定义，自定义可以自己定义返回的总数

addDBService

单表SQL构造条件：

addDBService

请求参数：

信息项 描述
headers参数 1.默认参数appcode、serial-number，当请求方式是POST,默认参数为Content-Type。
2.参数均不可编辑。
3.可以根据选择的认证方式自动生成
params参数 当发布方式是单表发布，可以选择添加，当发布方式是SQL发布，根据填写的SQL语句自动生成。
body参数 当请求方式是POST且发布方式是单表发布时，当发布方式是SQL发布，根据填写的SQL语句自动生成

根据认证方式生成headers参数

addDBService

根据SQL语句自动生成params参数

addDBService

返回参数：当发布方式是单表发布，可以选择添加，当发布方式是SQL发布，添加随机值可以编辑。

当发布方式是单表发布，可以选择添加 addDBService

当发布方式是SQL发布，添加随机值可以编辑。 addDBService

成功相应示例：根据返回参数自动生成

失败相应示例：默认值

点击保存成功后可以进行服务测试

# 服务版本测试

selectlist

数据状态为“待测试”和“测试通过”的服务版本可以测试。操作列点击“测试”图标，进入服务测试。

selectlist

1.可通过下方的“进入编辑”按钮随时进入服务编辑界面。“发送”按钮是置灰状态，不可点击。在“选择引擎”下拉列表选中引擎，会自动带出完整的请求地址。点击“请求地址唯一校验”按钮，校验请求地址的唯一性，校验通过后，“发送”按钮变成正常状态，可点击。

selectlist

2.还需要给headers、path、params、body参数设置具体的值才能发送请求。可以通过点击“全部填写随机值”、“全部填写默认值”和“全部使用示例值”设置值，还可以通过点击某行，进行编辑，输入具体值。 3.然后点击“发送”按钮，发送请求后，可以看到下方的接口响应信息。服务测试成功后，点击“确认测试通过”，服务的状态变为“测试通过”，“进入发布”按钮变成正常状态，可点击。点击“进入发布”，可进入服务发布界面。

# 服务版本发布

selectlist

数据状态为“测试通过”的服务版本可以发布。操作列点击“发布”图标，进入服务发布界面。

selectlist

selectlist

在服务发布界面，可以看到服务基本信息、后端资源信息、服务请求参数信息、响应示例信息。可点击“发布”按钮发布服务，操作成功后，服务的状态变为“已发布”。

# 流量控制

路径：【服务集成-服务治理-流量控制】

# 流量控制列表

list

查询：对已经维护的流量控制进行查询、搜索，搜索条件包含策略名称。

策略名称：文本框输入，支持模糊查询

删除：对已经维护的流量控制进行删除。

delete-btn

delete

# 流量控制新增

add

添加策略项

add-strategy

IP区间

ip-range

# 绑定API

对已经创建的流量控制进行绑定API操作。

bindapi-btn

绑定服务列表页

bindapi-list

新增服务

bindapi-add-dialog

bindapi-add-success

# 同步到引擎

bindapi-single-sync-success

# 黑白名单

路径：【服务集成-服务治理-黑白名单】

# 黑白名单列表

list

查询：对已经维护的黑白名单进行查询、搜索，搜索条件包含策略名称。

策略名称：文本框输入，支持模糊查询

删除：对已经维护的黑白名单进行删除。

delete

delete

# 新增黑白名单

add

添加策略项

add-strategy

# 绑定API

对已经创建的黑白名单进行绑定API操作。

bindapi-btn

bindapi-list

新增

bindapi-add-dialog

bindapi-add-success

# 同步到引擎

bindapi-single-sync-success

# 我的工作台

路径：【我的工作台-我的审批】

# 我的审批

需要当前用户需要审批的服务列表。

  • 我的审批：列表、查询、通过、驳回、展开(查看更多)

列表

userWorkbench/approvalList

申请服务的列表

查询

userWorkbench/approvalSelect

查询条件如下

申请服务：文本框输入，支持模糊查询。

审批结果：下拉列表，待审批、已通过、已驳回。

申请应用：下拉列表查询，当前用户所管理的应用列表，同菜单"系统管理/资源管理/应用管理"的列表数据一致。

提交时间：时间区间选择框，选择开始时间-结束时间。

通过

userWorkbench/approvalResolve

"待审批"状态下才可通过，点击通过按钮，即同意该服务被使用。

  • 审批意见：审批通过的意见，非必填。

驳回

userWorkbench/approvalReject

"待审批"状态下才可驳回，点击驳回按钮，即拒绝该服务被使用。

  • 审批意见：审批驳回的意见，非必填。

# 服务调用方

# 登录

输入正确的用户名密码验证码，即可进入主页

login

# 共享列表

路径：【API共享列表】

所有已发布成功的服务,可供所有用户申请使用，所有账号看到的服务列表一样。

包含

  • 服务列表：查询、服务列表。
  • 服务详情：详情、申请。
    • 详情：基本信息、API参数、使用指南。
    • 申请：申请使用该服务。

# 服务列表

apiList/list

查询

apiList/select

查询条件包含以下：

API列表：文本框输入。支持模糊查询。

所属业务领域：单选查询。

所属应用名称：单选查询。

排序：下拉列表

  • 按照上线时间倒序

服务概览

apiList/data

图上1为：所属业务领域。

图上2为：所属应用名称。

图上3为：服务名称。

# 服务详情

apiList/detail

禁止状态：表示数据为空。

基本信息

apiList/detailBaseInfo

图上1为：服务名称，图上2为：服务描述，所属业务领域，所属应用名称。

API参数

apiList/detailAPI

标签：服务的标签。如果没有数据则不显示。 调用地址：服务的调用地址。 请求方式：服务的请求方式。 请求参数：

  • 服务开放类型为RESTFUL 且 服务类型为编排服务（代理服务）：请求参数(path)、请求参数(headers)、请求参数(params) 、请求参数(body)。
  • 服务开放类型为RESTFUL 且 服务类型为库表服务：请求参数(headers)、请求参数(params)、请求参数(body)。
  • 服务开放类型为WEBSERVICE ：请求参数(headers)、请求参数(request)。
    • request 类型里包含服务的方法名和参数。

响应示例:

  • 是每条路由都包含：成功响应示例、失败响应示例。 点击路由即可切换。每个服务都有一个默认路由，即至少一个路由。

状态码定义：

code 参数
200 请求访问成功
ASGP-400 请求参数验证失败
ASGP-401 安全认证失败，Basic认证、Token认证、Api Key认证校验失败
ASGP-402 使用的应用未被授权访问该API
ASGP-403 拒绝访问，触发配置的黑名单
ASGP-404 API未部署
ASGP-429 API调用次数超出所配置的流量策略阈值
ASGP-500 引擎内部错误
ASGP-502 后端不可用，网络不可达错误
ASGP-503 后端不可用，服务超载或系统维护
ASGP-504 后端超时，与后端的网络交互超过预配置的时间错误

使用指南 apiList/useGuide 点击"使用指南"下载即可。

服务申请 apiList/apply

  • 已被卸载的的服务也属于发布状态的，可查看但不可申请。
  • 申请应用被申请后，不可再次申请，如果申请被审批驳回后即申请失败，便可再次申请。

# 我的工作台

路径：【我的工作台-我的申请】

# 我的申请

当前用户申请服务的列表。

  • 我的申请：列表、查询、下载使用指南、展开(查看更多)

列表

userWorkbench/applyList

当前用户审批的服务列表

查询

userWorkbench/applySelect

查询条件如下

申请服务：文本框输入，支持模糊查询。

审批结果：下拉列表，待审批、已通过、已驳回。

申请应用：下拉列表查询，当前用户所管理的应用列表，同菜单"系统管理/资源管理/应用管理"的列表数据一致。

提交时间：时间区间选择框，选择开始时间-结束时间。

下载使用指南

userWorkbench/applyUseGuide

点击"下载使用指南"按钮，即可下载到本地一个文档，供使用者查看。

"已通过"状态下才可下载使用指南。

# 消息中心

路径：【消息中心】

用户进行一些操作时，会收到一些消息，此处就是用户收到消息的列表数据。

列表

messageCenter/list

  • 全部：包含已读消息和未读消息。
  • 未读：只包含未读消息。

消息提醒

messageCenter/msgReminder

  • 用户登录成功后，如果该用户有未读消息，则会有未读消息提示，切消息中心处带有红点标记有未读消息。

  • 点击消息提示框可进入消息页面查看，也可点击header中的消息中心的图标。

  • 当用户收到一条消息时，会弹框消息提示。

  • 用户在一下几种会收到消息提示：

    • 系统初始化的时候默认内置一条未读的消息，提示他去做安全管理消息title：修改安全策略提醒。

    • 服务申请通过后会给申请人发送消息。

    • 服务申请驳回后会给申请人发送消息。

    • 固定token到期会发送消息。

    • 服务列表服务版本发生变化时发送消息。

    • 服务列表服务点击"暂停"发送消息。

查看

messageCenter/view

点击查看，会看到具体的消息内容，此时消息状态有未读转换成已读，小红点消失。

编辑页面 (opens new window)

← 安装部署→