随着技术的不断发展,系统间的交互越来越依赖API,用户可以根据服务接口信息深入了解所需要的产品,这样不仅可以使大众快速理解产品作用,也可以进行更广泛的推广。
ESB中API管理模块下API服务接口功能可以注册、导入、配置服务,支持新增、添加接口,为了方便外部查看访问,需要对外提供查询服务列表、查询服务配置、查询接口配置三种接口,API安全可以对服务接口和流程配置安全报警策略,发送报警信息等。
1总体介绍
本文档是介绍SMC控制台中API管理模块,对其模块中的功能进行梳理,方便快速了解API管理模块中的功能。
1.1体系结构
ESB对API的支持主要体现在API管理、API安全和API集成,其中API管理又细分为API划分、创建和监控。
与一般的API管理不同的是,公司的API是基于ESB平台管理的,因此在管理功能上会受到ESB一定程度的影响。
1.2基础理念
API的本质是应用程序编程接口,目的是保障系统间的交互功能,在这方面公司也有所考虑,通过对ESB平台来实现API网关的注册及管理,这样就可以复用ESB的集成功能,保障API的系统对接功能。
API管理的核心功能包含API生命周期管理、API版本管理、API安全管理,其他辅助功能有API运行监控、调用记录、参数统计等,公司的API管理包括API接入、API注册、API调用。API的版本管理是通过API的路径和版本记录来实现的,API安全支持不同类型的认证方式、黑白名单等。
1.3功能说明
API管理模块中的功能,基础功能有应用管理、API分组、API服务以及API代理,安全预警方面有API标签、API安全,还有API超市模块。
应用管理可以进行应用配置和安全管理,API服务管理可以对注册服务、配置服务、代理服务进行操作,配置接口等;API安全管理可以对流程或接口配置安全报警机制,API代理可以对注册服务进行代理,API标签中有微信、短信、邮件。API超市分为三类API分组查询、API应用查询、API调用查询。
2基础功能
下面对API管理中的应用管理、API分组、API服务、API代理等模块功能进行介绍说明。
2.1应用管理
应用管理模块:支持新增、编辑、复制、查看、删除操作,可以根据系统编码和系统名称进行查询,其功能是对各个应用系统进行管理。列表页面如下:
表单页面有生成密钥功能,可以生成公钥和私钥,进行加密和解密,具体表单页面如下:
安全管理支持权限管理,可以根据标准角