细谈电商网站外链建设的策略,石家庄网站设计制作,注册城乡规划师报名入口,58上海同城网随着信息化飞速增长的还有各信息系统中的应用接口#xff08;API#xff09;#xff0c;API作为信息系统内部及不同信息系统之间进行数据传输的渠道#xff0c;其数量随着软件系统的不断庞大而呈指数型增长#xff0c;如何管理这些API已经在业界变得越来越重要#xff0c…随着信息化飞速增长的还有各信息系统中的应用接口APIAPI作为信息系统内部及不同信息系统之间进行数据传输的渠道其数量随着软件系统的不断庞大而呈指数型增长如何管理这些API已经在业界变得越来越重要需要将API 开发的敏捷性、速度和效率提升到了全新的水平。 API管理
很多人认为API的管理无非是对API信息的管理只要将API记录在Word或Wiki文档就足够了这其实是一种想当然的想法。根据实际经验这些文档随着时间的推移缺少维护而逐渐变成了最初工作的凭证而已已和实际运行的API大相径庭了已失去了其作为API文档的意义了。
在目前成功的API管理实践中API管理应该至少包括以下内容
API文档信息管理
API测试质量管理
API研发流程管理
API自动测试管理
只有至少实现了以上四点才能称之为有效的API管理API才能更有效地服务于企业把 API 的开发提高到新的水平。 API管理现状
现有应用系统大多采用前后分离端架构或微服务架构一般规模的系统至少有上百个API对于庞大的系统包含数千个API是很正常的并且系统内的API不仅数量众多并且种类各异分布在不同的地方。目前API管理主要存在以下难点
1API信息管理困难
由于系统中拥有纷繁复杂的API在研发过程中因疏漏无法及时更新API信息的情况时有发生最后会导致API信息出现缺漏。对于API的开发者和使用者来说API文档信息逐渐失去参考价值对于项目管理者来说API信息无法与测试、项目迭代进度等内容关联起来无法了解项目的实际研发、测试和运行情况。
2API研发协作困难
在API管理平台不统一的情况下每个项目团队都有自己的使用习惯或历史遗留问题平台不统一导致无法维护和协作。并且由于API变更时没有及时更新文档和通知到相关人员导致项目检查、后期测试、前后端对接过程中高昂的沟通成本拖后项目的进展。
3API测试困难
测试人员需要看着接口文档再另外使用工具进行测试另外接口发生了变化需要重新再写测试用例增加了工作量降低了效率。测试总是排在最后进行无法参与项目讨论无法快速大范围回归测试甚至无法按时完成测试任务导致项目延期或者忐忑上线。 4API自动化测试困难
测试人员需要学习编程语言去编写测试脚本但是测试脚本因更新不及时、编码风格不完善、不方便协作等原因导致使用成本较高测试报告也不够清晰。 5API测试管理困难
测试团队以及项目管理人员无法准确了解测试效果无法通过数据来量化当前项目质量。项目管理人员缺乏一个平台来展示团队开发进度如完成需求量情况是否通过测试、对接和发布等信息。 Eolink Apikit 的解决之道
Eolink Apikit 提出针对API开发协作的创新理念——文档与测试驱动开发DTDD何为文档与测试驱动开发呢简而言之
1用标准文档代替口头约定和笔记文档让开发、测试、运维、协作有迹可循
2快速用测试结果推动开发进度让团队沟通更充分、管理有事实依据实现敏捷开发。 依据这个理念Eolink提供一套先进的解决方案目标是降低研发过程中因为API管理导致的效率低下、测试不清、管理困难等问题通过敏捷的API研发管理方案和理念来推动企业业务的快速发展。 下图所示为 ApiKit 解决方案示意图 Eolink Apikit 的实战
1.API信息管理
全面的API信息管理模块通过手动 或自动方式生成API信息全面记录和展示API信息。 1设计API能够详细、规范地记录API的所有信息可以通过它来设计、统一API的开发规范如下图所示。除了手动创建API外还可以从其他工具或系统导入已经设计好的接口如Postman、Swagger、Jmeter、Apifox、YApi等。 2管理APIAPI信息里面会记录创建人、负责人、最后修改时间等信息并且可以为API定义Tags对API进行分类可以更好地对API进行管理如下图所示 除此之外还可以绑定Github、Gitlab、码云等代码仓库可以一键自动生成API文档也兼容Swagger代码注解生成API文档。 2.API测试管理
一键发起测试拥有专门的测试编辑器可以直接编写JSON、XML数据还可以支持自动生成测试数据能够通过Javascript代码对请求参数、放回结果进行二次加工实现复杂场景的测试。 系统会记录每一次请求的历史可以看到详细的测试时间、请求及返回信息等这样保证了测试结果可查并且可追溯。 3.API自动化测试
Eolink实现了零代码实现API自动化测试能够让测试人员通过界面就可以完成自动化测试并且提供了Javascript脚本模式可以通过非常简单的脚本来编写复杂的API测试用例实现自动化测试中复杂的流程跳转、数据加解密、验签等目的。 4.API研发管理
通过把产品系统的各个研发周期串联起来可实现产品、开发、测试、运维等各个环节和人员的综合协作。通过Mock API可以实现前后端同时开发通过API状态统计可以快速了解到当前项目内所以API的状态分布除此之外还可以制定迭代计划并跟踪开发进度将API绑定到迭代计划上可以帮助团队将开发进度精确到以API为单位实现更精确的进度跟踪。
除此之外还可将API设置为已发布、设计中、待确定、开发、对接、测试、完成、异常、维护发、废弃等状态可根据每种状态设置状态变更操作如当API变为测试状态时测试人员当然状态发生改变或改变接口本身时也可以手工选择需要通知的人员。如下图所示当更新接口状态时不仅需要更新相关变更信息而且还可以选择是否触发变更通知。
