乐趣区

关于api:8年开发浅谈-API-管理

随着信息化飞速增长的还有各信息系统中的利用接口(API),API 作为信息系统外部及不同信息系统之间进行数据传输的渠道,其数量随着软件系统的一直宏大而呈指数型增长,如何治理这些 API 曾经在业界变得越来越重要,须要将 API 开发的敏捷性、速度和效率晋升到了全新的程度。

API 治理

很多人认为,API 的治理无非是对 API 信息的治理,只有将 API 记录在 Word 或 Wiki 文档就足够了,这其实是一种想当然的想法。依据理论教训,这些文档随着工夫的推移,短少保护,而逐步变成了最后工作的凭证而已,已和理论运行的 API 天壤之别了,已失去了其作为 API 文档的意义了。

在目前胜利的 API 治理实际中,API 治理应该至多包含以下内容:

1)API 文档信息管理
2)API 测试品质治理
3)API 研发流程治理
4)API 自动测试治理

只有至多实现了以上四点,能力称之为无效的 API 治理,API 能力更无效地服务于企业,把 API 的开发进步到新的程度。

API 治理现状

现有利用零碎大多采纳前后拆散端架构或微服务架构,个别规模的零碎至多有上百个 API,对于宏大的零碎,蕴含数千个 API 是很失常的,并且零碎内的 API 不仅数量泛滥,并且品种各异,散布在不同的中央。目前 API 治理次要存在以下难点:

1)API 信息管理艰难

因为零碎中领有纷繁复杂的 API,在研发过程中因疏漏无奈及时更新 API 信息的状况时有发生,最初会导致 API 信息呈现缺漏。对于 API 的开发者和使用者来说,API 文档信息逐步失去参考价值;对于我的项目管理者来说,API 信息无奈与测试、我的项目迭代进度等内容关联起来,无奈理解我的项目的理论研发、测试和运行状况。

2)API 研发合作艰难

在 API 治理平台不对立的状况下,每个我的项目团队都有本人的应用习惯或历史遗留问题,平台不对立导致无奈保护和合作。并且因为 API 变更时没有及时更新文档和告诉到相干人员,导致我的项目查看、前期测试、前后端对接过程中昂扬的沟通老本,拖后我的项目的停顿。

3)API 测试艰难

测试人员须要看着接口文档再另外应用工具进行测试,另外接口产生了变动,须要从新再写测试用例,减少了工作量升高了效率。测试总是排在最初进行,无奈参加我的项目探讨,无奈疾速大范畴回归测试,甚至无奈按时实现测试工作,导致我的项目延期或者忐忑上线。

4)API 自动化测试艰难

测试人员须要学习编程语言去编写测试脚本,然而测试脚本因更新不及时、编码格调不欠缺、不不便合作等起因导致应用老本较高,测试报告也不够清晰。

5)API 测试治理艰难

测试团队以及项目管理人员无奈精确理解测试成果,无奈通过数据来量化以后我的项目品质。项目管理人员不足一个平台来展现团队开发进度,如实现需求量状况,是否通过测试、对接和公布等信息。

Eolink Apikit 的解决之道

Eolink Apikit 提出针对 API 开发合作的翻新理念——文档与测试驱动开发(DTDD),何为文档与测试驱动开发呢?简而言之:

1)用规范文档代替口头约定和笔记文档,让开发、测试、运维、合作有迹可循;
2)疾速用测试后果推动开发进度,让团队沟通更充沛、治理有事实根据,实现麻利开发。

根据这个理念,Eolink 提供一套先进的解决方案,指标是升高研发过程中因为 API 治理导致的效率低下、测试不清、治理艰难等问题,通过麻利的 API 研发治理计划和理念来推动企业业务的疾速倒退。

下图所示为 Eolink 解决方案示意图:

Eolink Apikit 的实战

1.API 信息管理

全面的 API 信息管理模块,通过手动 或主动形式生成 API 信息,全面记录和展现 API 信息。

1)设计 API:可能具体、标准地记录 API 的所有信息,能够通过它来设计、对立 API 的开发标准(如下图所示)。除了手动创立 API 外,还能够从其余工具或零碎导入曾经设计好的接口,如 Postman、Swagger、Jmeter、Apifox、YApi 等。

2)治理 API:API 信息外面会记录创建人、负责人、最初批改工夫等信息,并且能够为 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 变为测试状态时测试人员,当然,状态产生扭转或扭转接口自身时,也能够手工抉择须要告诉的人员。如下图所示,当更新接口状态时,不仅须要更新相干变更信息,而且还能够抉择是否触发变更告诉。

总结

以上展现只是 Eolink Apikit 弱小 API 治理性能中的极小一部分,除了 API 治理外,ApiKit 还提供了自动化测试服务、API 网关、API 监控、API 主动生成等服务。ApiKit 是国内 API 治理解决方案的领军者,是国内最大的在线 API 治理服务供应商,服务了包含泰康在线、苏州银行、太平洋证券、阳光保险团体、联通领取等泛滥机构。

通过对 ApiKit 试用,深认为其不愧为精心打造的 API 治理利剑,如果您有须要或感兴趣,能够在其提供 SaaS 版本上收费应用!

官方网站:
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy03

退出移动版