背景

在企业数字化转型过程中，企业内部之间的业务系统需要相互协作完成业务协作，外部需要和上下游供应商、伙伴、客户等紧密连接。同时企业系统运行在多个混合云环境及SaaS中，私有端大量业务系统与云端系统形成了错综复杂的集成关系，企业面临集成技术复杂多样、API管理混乱、故障定位困难等挑战，传统以SOA为主的单体ESB产品已很难满足这种混合集成需求， 随着微服务架构以及容器技术的推出，新一代以API为中心的轻量级API服务治理平台顺应而生，金蝶天燕APUSIC API服务治理平台为全面解决企业面临的各种复杂集成场景而提供价值。

产品介绍

产品定位

金蝶天燕APUSIC API服务治理平台（简称ASGP）是一个针对API对象进行服务管理、服务治理、服务价值分析的企业级平台。在企业加快数字换转型过程中，ASGP可以解决企业内部各应用系统之间相互调用，服务共享的基础设施平台；同时ASGP也可以 在打通上下游供应商、伙伴、客户时，作为一个API服务开放平台，把API作为核心资产并进行管理和运营，从而实现API的服务变现问题

产品受众

• 管理员

  管理员对平台内的各种基础信息做配置化管理，包括用户、角色、权限及基础安全配置。同时对平台的访问日志具备审计功能。

• 开发者

  开发者可以在此平台中根据可视化配置快速代理、编排出一个新的API服务。还可以通过数据单表或者编写SQL的方式，把数据库中的数据集合快速发布成一个API对象。同时可以对API全生命周期进行管理。

• 业务领导

  业务领导需要关心平台中的API被应用情况，主要表现在API对象主要应用在哪些领域或者被哪些部门在调用，这个API到底产生了多少价值。

• 服务运营人员

  API服务被调用需要发起申请，并由服务运营人员进行审核和审批，只有审批通过的API服务才能被实际应用。

核心能力

• 云原生

  基于云原生标准组件、微服务应用架构构建，支持水平扩容，无单点故障，全面支持公有云、私有云等环境部署模式，全面兼容K8s、Docker等部署。

• 全面适配信创环境

  金蝶天燕中间件团队具有非常丰富的信创经验，产品在国产芯片、操作系统、中间件、数据库方面都有比较完美的运行效果。

• 统一集中管控

  API服务治理平台支持大型集团复杂的组织架构形式，同时采用管控台和服务引擎相分离的架构设计思想，集团内各组织用户都可集中在统一的管控台下进行业务配合和操作，而实际负载的引擎又分别独立运行互不干扰，这样可以有效地对集团内业务进行统一管控、统一分析、统一监控。

• 全生命周期管理

  API服务治理平台包含API开发和API管理两大生命周期管理。API开发包括API 的定义、设计、开发、测试、发布生命周期管理功能。API管理包括启动、暂停、停止、下线等管理功能。

• 服务网关能力

  API服务治理平台具备网关核心能力，包括服务调用认证鉴权、安全传输、黑白名单限制、灰度发布、发布回滚、流控、熔断、降级等能力。

• 轻量级的企业服务总线

  API服务治理平台是一个企业级的IT架构平台，采用微服务架构设计思想，除了具备API网关的核心能力外，还具备协议转换、消息智能路由、服务编排等特性，可以替代传统SOA架构下的重量级企业服务总线。

• 数据库快速发布成API

  支持主流国内外数据库单表发布或者编写SQL语言的方式，快速把数据库数据集合发布成API服务。

• 统一分析及监控

  API服务治理平台面向不同用户不同视角，展示多维度的统计分析，并对平台运行状况和API调用情况进行实施监控，保证平台稳定可靠运行。

产品功能

功能架构

功能架构图

功能清单

功能清单及简要说明

系统管理

系统配置

角色权限配置

通过权限管理、组织管理、角色管理、账户管理、角色分配五个菜单实现系统的角色、权限分配，保证系统的权限隔离。

业务领域

对业务领域进行定义，方便对API进行分类，统一管理。

全局配置

系统内的全局共有属性进行配置，如logo、平台名称、服务监控查询间隔、导出数据上限数量等。一旦客户需求与系统初始化不一致，灵活配置，配置即生效，无需修改代码或重启。

资源管理

引擎管理

维护服务发布的引擎终端，支持维护单机版引擎和集群版引擎，实时展现引擎状态。

应用管理

维护平台内的应用，应用进行系统数据权限隔离，通过配置应用的集成负责人对该应用下的服务、后端资源进行过滤。

数据源管理

维护数据源，为后续新增库表服务的时候选择数据源做准备。目前支持mysql、oracel、达梦数据库。

SSL证书管理

维护ssl，为引擎的https端口访问通畅提供在线上传证书保障。

日志审计

• 登录登出日志

记录用户在平台登录/登出成功/失败的日志。

• 业务操作日志

记录用户在平台各种操作行为(登录登出除外)的日志。

安全管理

通过页面对平台安全相关项进行配置，包含账户口令类、账户行为类、其他。一旦客户需求与系统初始化不一致，灵活配置，配置即生效，无需修改代码或重启。

• 账户口令类

  包含首次登陆口令强更新、口令强度设置、口令有效期设置，修改后保存即按照当前页面配置生效。

• 账户行为类

  包含多次登陆检测、错误登陆锁定，修改后保存即按照当前页面配置生效。

• 其他类

  包含文件增加水印、账户登录加密算法、会话有效期设置，修改后保存即按照当前页面配置生效。

服务集成

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

借助服务治理平台，可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放。服务治理平台让客户专注于企业核心业务，提升运营效率。

服务首页

展示平台的图表数据，对平台内该用户管理的应用下已发布服务总数、已发布库表总数、被申请服务、后端资源进行多维度的统计、分析，并对服务所属业务领域和热门资源进行图形化展示。

服务管理

后端资源

平台对被代理的API对象做统一管理，支持HTTP和SOAP协议，支持自定义header参数、path参数、param参数、body参数及安全认证信息、支持自动解析，支持自定义的json或xml格式的响应成功或响应失败信息。 同时支持swagger文档和wsdl文档规范，并设有swagger文档和wsdl导入功能，方便运维及实施人员的快速创建后端服务，提高服务集成上线效率。

• 安全认证

  根据后端资源的实际需要，设定对应的安全认证参数，保证后端资源在平台中的一致性。

  安全认证	说明
  无认证	该后端资源无认证
  BasicAuth	该后端资源使用basic认证，代理服务或编排服务使用该后端资源，会给该后端资源默认传参basic认证参数
  BearerToken	该后端资源使用BearerToken认证，代理服务或编排服务使用该后端资源，会给该后端资源默认传参BearerToken认证参数
  APIKey	该后端资源使用自定义key:value类型，代理服务或编排服务使用该后端资源，会给该后端资源默认传参自定义的认证参数

  

• 自动解析

  自动解析，自动解析http服务地址中的path参数和param参数，支持json参数解析，支持自动解析SOAP协议wsdl地址包含的各operation，避免手动填写过程中出现错误，减少工作内容

  http协议

  

  

  SOAP协议

  

• 后端资源导入

  根据swagger文档规范和wsdl文档规范，设有swagger文档和wsdl导入功能，方便运维及实施人员的快速创建后端服务，提高服务集成上线效率。

  

服务列表

服务列表提供全生命周期的API管理，从服务定义、服务设计、服务开发、服务测试、服务发布，到服务启动/暂停、服务卸载、灰度发布，帮助您轻松管理和部署API。

• 安全认证

  对平台发布出去的服务增加一层新的安全认证，只有通过了安全认证，引擎才允许进行后端资源的真实访问。

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

• 服务代理

  通过此功能用户只需要简单的五步，通过页面可视化快捷配置，把一个API对象快速的管理起来并发布出去，在这个过程中可以HTTP服务转化成安全性更高的HTTPS服务，并可以设置接口数据缓存时间，来提高响应速度和可用性、可以增加安全认证、扩展服务地址。

  

  

  

• 编排服务

  编排服务功能除了具备代理服务的所有功能外，支持将多个第三方接口编排为一个新的服务，统一入口，同时还具备把请求参数和后端资源参数（包括head、param、body、path）进行参数映射的功能，并可以设置路由规则，根据不同的路由规则寻找不同的后端资源，可以实现一个轻量级的ESB。 服务编排能力，这样在一些特定场景下可以取代ESB架构太沉重的问题。

  

  

  

  --自动映射

  参数提供连线映射，对于相同参数名称、参数类型的可以进行自动映射，减少用户操作事务，提升操作效率。

  

• 库表服务

  在企业中一般存在一些遗留系统，这些系统已经没有运维人员在维护，在企业信息化转型过程中，同时需要这些遗留系统的数据。数据库发布服务功能，可以根据数据库连接信息快速生成API服务，并纳入API管理范畴。不仅仅支持数据库表和视图，同时还支持编写自定义SQL，把返回的数据集合发布成一个API接口，并加入了安全机制，可以放心使用。

  

  

  单表发布

  

  

  SQL发布

  

• 灰度发布&灰度策略

  在API的生命周期中，有时会出现多个版本同时出现的情况，当最新版本的API还不够成熟和稳定的时候，这时就需要灰度发布这个功能。灰度发布可以设定灰度策略，限定某些APP才能访问最新的版本，当这个新版本运行稳定且正常时，就可以把流量全部切到最新版本上。如果最新版本运行还不够稳定，可以随时切回原来版本，保证客户端的正常调用。

  

• 全生命周期管理

  API服务治理平台采用定义、设计、开发、测试、发布等五步走的设计思想，对API的开发过程进行全生命周期可视化设计。同时还支持启动、暂停、卸载等生命周期管理。

  

服务治理

流量控制

通过流量控制设置可以有效的控制API调用的流量，可以控制单位时间内IP和IP段的流量，时间颗粒度支持天、小时、分钟、秒。同一个流控策略可以绑定多个服务，支持同时/分别将流控策略同步到引擎端。

黑白名单

通过黑白名单设置可以有效控制API的调用权限，目前支持IP和IP段控制设置。同一个黑白名单可以绑定多个服务，支持同时/分别将黑白名单同步到引擎端。

服务日志

服务测试日志

对API在平台中测试过的用例都进行日志保存，以便更好的了解API测试中的状态，更方便发现在测试中存在的问题。每条数据都会记录操作详情,点击操作详情按钮可弹框查看，包含请求报文、响应报文。

• 报文加密

默认后台对日志进行加密，需要手动触发解密查看报文。

服务调用日志

API在被调用过程中，存在很多环节，包括认证、鉴权、映射、转换等，这些过程在调用日志都有调用时长、成功、失败等记录，特别增加客户端流水号，要求用户传递唯一流水码，便于在调用过程中定位问题所在。每条数据都会记录操作详情，点击操作详情按钮可弹框查看，包含请求报文、响应报文。

• 报文加密

默认后台对日志进行加密，需要手动触发解密查看报文。

服务分析

统计分析主要体现在以下几个方面：

服务调用

统计每个API被调用的总次数、成功次数、成功率、失败次数、失败率、平均响应时长；针对以上数据继续下钻，统计出每个应用调用的总次数、成功次数、成功率、失败次数、失败率，平均响应时长。并提供统计分析报告。

部门调用

统计每个部门作为提供方被调用的总次数、成功次数、成功率、失败次数、失败率、平均响应时长；针对以上数据继续下钻，统计出每个应用调用的总次数、成功次数、成功率、失败次数、失败率，平均响应时长。并提供统计分析报告。

统计每个部门作为消费方调用的总次数、成功次数、成功率、失败次数、失败率、平均响应时长；针对以上数据继续下钻，统计出每个应用调用的总次数、成功次数、成功率、失败次数、失败率，平均响应时长。并提供统计分析报告。

资源调用

统计每个库表API服务被调用的总次数、成功次数、成功率、失败次数、失败率、平均响应时长；针对以上数据继续下钻，统计出每个应用调用的总次数、成功次数、成功率、失败次数、失败率，平均响应时长。并提供统计分析报告。

共享列表

服务共享列表

服务共享列表页里主要展现各组织、各部门已共享出来的API列表，方便供消费方查询和申请，并支持按API名称、应用、领域、标签等多种联合查询方式

服务详情及申请

对具体服务进行查看，里面包含服务基本信息、服务参数、服务错误码、服务使用指南。

提供对当前用户所管理的应用进行调用申请。

服务监控

服务监控中设定了几个调用模型，主要表现在：

• 调用流量监控

  调用流量包括字节流量和调用次数流量两种，实时的展现多个API之间相互的调用流量，可以有效的判定出API的重要性及数据的流转情况，以便对特定的API做相应的保护策略。

• 调用关系监控

  平台通过分析应用之间的血缘关系，实时观测应用之间的调用关系，并且可以体现出应用的重要程度，以便决策者更有针对性地资金、资源倾向性的投入。

• 健康度检查

  平台设定了API可用性和调用性能作为因子的模型，通过计算给每个API进行评分，评分结果反应每个API的健康度，通过散点图可以在监控页面实时的观测到每个API的健康状态。

• 按时间段监控平台流量

  实时监控整个平台在每个时间段内的调用次数，让运维工程师更清楚的知道平台的调用峰值经常出现的时间区间，以便给流量控制策略提供更精准的依据。

• 调用响应监控

  在API调用过程中，每个API调用时间过长，那么出现问题的概率就会越大，平台会把每个API的调用时长进行排序，实时的展现调用时长最大的API集合，并能直观的看到这些调用在每个环节所发生的时间，更好的定位性能瓶颈所在。

个人中心

• 个人资料

  用户在此处可以查看自己的个人相关信息及修改登录口令。

  

• token管理

  用户在此可以查看自己所有调用API的Token及Token相关状态，对即将到期的Token可以及时申请。

  

我的工作台

• 我的申请

  对已申请的API及状态做统一管理，并且可以查看及下载已申请API的说明文档。

  

• 我的审批

  展现所有提交过来的申请调用信息，并对此信息进行批准或驳回等操作。

  

消息中心

• 站内消息

  通过站内消息及时的通知用户申请API的审批结果及认证信息，还包括安全策略调整通知、密码到期提醒、多次登录通知提醒等信息。

  

部署方案

• 单节点部署

  一个管控端+N个节点（每个节点1个服务引擎）部署的模式，在此部署模式下，管控端和服务引擎都是单节点部署。

• 集群部署

  两个管控端+N个节点（每个节点至少2个服务引擎）部署的模式，在此部署模式下，管控端和节点都做了高可靠，避免出现单点故障。