从零到壹-API研发管理心得分享

简介: 小五有一家软件公司,邀请虚竹哥给他们做一场关于api研发管理的分享,虚竹哥把分享的要点整理成文章,分享给大家。

零、前言

小五有一家软件公司,邀请虚竹哥给他们做一场关于api研发管理的分享,虚竹哥把分享的要点整理成文章,分享给大家。

一、API 研发管理

1.1、什么是API研发管理

你是否认为API管理无非是管理一下API文档(如何把文档写漂亮一点,规范一点),只需要用word文档API描述写一下,要团队协作时,把API文档文件发给前端或测试人员就行?

其实没这么简单,API研发管理是:包含了API开发管理、开发团队协作、自动化测试、网关以及监控等等API管理全生命周期的一系列管理过程。帮助公司实现开发运维一体化,提升开发速度,提升产品质量并且降低运维成本。

API管理最重要的方面包括检测,分析和报告,使用工具来量化分析api的情况。传统的管理格言是,“无法管理没有指标的东西。”

1.2、痛点

虚竹哥发现的痛点有如下几方面:

  1. 前端开发进度受制于后端;
  2. 无法及时了解API变动;
  3. 接口测试不方便;
  4. 测试工作繁琐、重复;
  5. 工作成果无法分享;
  6. 测试工作不自动化;
  7. 测试效果无法量化;
  8. 测试工作被动;
  9. 合作方需要我们在极短的时间内提供接口文档文件,对平时不注重api管理的团队来说,是一个加班的消息了;

这些痛点,大家是否感同身受~说多了都是槽点,说多了都是泪啊

1.3、解决方案

道:规范的思维

提升团队规范思维,了解规范地管理API能便于开发、测试和维护。

法:合理的流程

制定合理的工作流程,保障团队成员能够各司其职,高效协作。

器:适用的工具

选择合适的工具来实践流程,工具能够帮助团队成员规范日常开发行为。

术:易用的体验

良好的产品使用体验+团队成员的熟练运用工具,能够保障流程持久运作,最终实现规范的目标。

以eolink为例,介绍如何搭建和使用API研发管理。

eolink 有私有部署产品和SaaS 产品,可以满足不同企业的需求。

二、搭建部署及不同角色的关注点介绍

2.1、下载安装

下载传送门--》
在这里插入图片描述
根据电脑的操作系统,选择下载
在这里插入图片描述
选择安装目录:
在这里插入图片描述
安装成功后:
在这里插入图片描述

2.2、开发管理

创建项目及从第三方导入api

进入 API 研发管理项目列表页,点击 添加 按钮。
在这里插入图片描述

可以新增api接口,也可以从第三方导入api接口:

在这里插入图片描述
小五公司的后端接口是用使用swagger生成api接口
可以使用swagger导出的json文件,批量导入进来。
在这里插入图片描述
像这种swagger的json文件如何获取呢?
简单介绍下:
以java项目为例,我们会对swagger 的api接口进行分组。
不同技术团队写法可能会有差异,建立直接写在配置文件中即可
在这里插入图片描述

我们就可以把整个分组的接口以json文件格式输出
格式:

/v2/api-docs?group=分组名
localhost:9527/v2/api-docs?group=分组名
其中localhost:9527/ 是本地后端服务ip和端口。

[图片]

右键,网页另存为json文件,文件名可自定义。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
这样就导入完成了。
可以给项目关联 Swagger 生成的 JSON 文件地址或关联代码仓库,API 研发管理平台能够远程读取代码并自动生成API文档。
在这里插入图片描述
在这里插入图片描述
配置完成后,界面会提示配置完成。此时您可以通过在当前页面页点击 同步 按钮
在这里插入图片描述
不止支持swagger导入,还支持很多种导入数据类型,大家可自行体验,可以跟虚竹哥探讨探讨。
在这里插入图片描述

api变更通知

这个功能对于模块的开发负责人是福音。当团队成员某个需求或某个bug,修改了api接口,早期相关负责人是无法及时得知的,只能去看提交记录。

有了api变更通知,模块开发负责人对负责模块的api 情况了如指掌,有问题也能及时发现并提醒。

把某个出参/入参移除,对某个业务是不影响,但会影响其他业务,负责新需求开发的人,不一定了解这个情况。
新增了不少出参,但实际应该另开一个api接口,原先这个api接口的作用是如此如此~这般这般~

可以单个接口设置通知:
在这里插入图片描述
也能全局配置:
在这里插入图片描述

2.3、测试管理

编写测试用例

痛点:测试人员工作总是排在最后进行,无法参与项目讨论,无法进行快速大范围回归测试,甚至无法按时完成测试任务,导致项目延期或带着忐忑上线。
使用协作工具后优势:开发人员将API文档写好之后,测试人员就可以马上介入,在API文档的基础上编写测试用例; 等开发人员开发api后,测试人员可直接执行测试用例,一键对 API 进行冒烟测试,并且得到详细的测试报告,如果有异常则可针对性改进。
还有一个优势,当api发生变更时,测试人也能及时知道,并修改api测试用例。

创建测试用例:
在这里插入图片描述
填写 API 的请求地址、请求参数、校验规则等信息:
在这里插入图片描述
还可以智能地校验返回结果:
在这里插入图片描述
支持多种校验方式:
在这里插入图片描述

批量测试

在这里插入图片描述
测试报告:
在这里插入图片描述
会计算测试通过率:
在这里插入图片描述

不同环境的测试

需要测试的环境有:开发环境(一般开发人员自测)、测试环境、预发布环境和生产环境(一般不会直接测试,除非有线上问题发生)
痛点:这些环境服务的地址和端口很有可能是不一样的,要修改大量的测试用例,工作量非常大。
使用协作工具后优势:可以定制不同环境的项目环境,设置项目内API的请求地址前缀、全局变量、额外参数等信息。可以一键切换项目环境而不需要修改API文档。

创建项目环境:
在这里插入图片描述
在这里插入图片描述

请求地址前缀

给项目内所有API加上统一的请求地址前缀。

额外请求头部

给 API 加上统一的请求头部。

额外Form-data请求参数

如果API的请求体是Form-data类型,则会加上额外的请求参数。

切换环境

如图位置,可切换环境
在这里插入图片描述

2.4、项目管理

一键快速生成API接口文档

可以将项目的API文档导出为多种离线格式,方便分享给团队以外的人。
在这里插入图片描述

支持多种导出格式:
在这里插入图片描述

支持导出指定分组的api文档

在这里插入图片描述
在这里插入图片描述

统计分析

对项目管理者来说,要能快速直观地了解这个项目的情况,有一个统计分析报表,是非常重要的

在这里插入图片描述
在这里插入图片描述

api测试用例报告

项目管理者细节跟进:可查看所有的api测试用例报告,清晰地了解,api都有什么问题及时发现问题,并组织或分享问题及解决方案,提高研发效率。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
测试用例报告详情:
在这里插入图片描述

三、总结

我们来回顾下,本次分享介绍了什么是API研发管理,传统的研发流程的api管理有大量的痛点,涉及开发人员,测试人员和项目管理人员,虚竹哥给出了一个建议解决方案:“道、法、器、术” 四字口诀。

分享了理论基础的同时,也分享了如何在协作工具eolink上运用理论知识,理论与实践的结合,才是分享鸡汤又给勺子的正确打开方式。

四、参考资料

eolink官网

相关文章
|
API 开发者
接口开放平台的产品设计脑图及解决方案
接口开放平台的产品设计脑图及解决方案
|
2月前
|
人工智能 关系型数据库 MySQL
数据魔力,一触即发 —— Dataphin数据服务API,百炼插件新星降临!
本文通过一个利用百炼大模型平台和Dataphin数据服务API构建一个客户360智能应用的案例,介绍如何使用Dataphin数据服务API在百炼平台创建一个自定义插件,用于智能应用的开发,提升企业智能化应用水平。
179 4
数据魔力,一触即发 —— Dataphin数据服务API,百炼插件新星降临!
|
区块链
养鱼玩法元宇宙平台合约开发源码详情
function createFish(address player, FishType type) public returns (uint index) { Fish memory fish = Fish({ type: type, level: 1, experience: 0 });
|
8月前
|
监控 供应链 搜索推荐
革新商务数据体验:引领市场的API商品数据接口
在当今商业环境中,革新商务数据体验对于维持竞争优势至关重要。API商品数据接口在这一转型过程中扮演了核心角色,它不仅为企业提供了实时且全面的数据访问能力,而且还极大地增强了数据的可操作性和决策支持功能。以下是API商品数据接口如何细致地改善商务数据管理:
|
8月前
|
人工智能 JavaScript API
互联网人的福利!『昆仑天工』4款AI产品开源!提供API对接!
互联网人的福利!『昆仑天工』4款AI产品开源!提供API对接!
488 0
|
8月前
|
监控 数据可视化 数据挖掘
揭秘抖音视频详情API:电商行业的制胜法宝与实时数据获取的奥秘
随着社交媒体的普及和电商行业的快速发展,抖音等短视频平台已经成为电商企业获取用户、推广产品和了解市场趋势的重要渠道。获取抖音视频详情API对于电商行业来说具有重要意义,它可以帮助企业实时获取抖音平台上的视频数据,洞察用户需求,优化产品策略,制定精准营销计划,从而提升竞争力。
|
8月前
|
自然语言处理 供应链 搜索推荐
拼多多API:电商智能化发展的强大引擎
随着互联网的快速发展和数字化转型的加速,电商行业正面临着前所未有的机遇与挑战。在这个背景下,拼多多API作为电商智能化发展的强大引擎,正发挥着越来越重要的作用。本文将探讨拼多多API如何助力电商智能化发展,以及它在未来的无限可能性和创新空间。
|
8月前
|
安全 测试技术 Linux
国内Api行业,可以内卷到什么程度?
国内Api行业,可以内卷到什么程度?
|
安全 搜索推荐 程序员
身为产品经理该如何向客户推广API商品数据接口,该如何跟进项目和程序员对接?
API是Application Programming Interface的缩写,即应用程序编程接口。API商品数据接口是一种允许不同应用程序或系统之间进行数据交互的方式。通过API商品数据接口,不同的应用程序或系统可以相互调用和共享数据,而不必直接相互通信或共享数据。
|
测试技术 API
Eolink 全新一代「AI+API」协作管理平台,大模型驱动打造 API 研发管理与自动化测试
行业首发!Eolink 全新一代「AI+API」协作管理平台,实现「AI+API」结合,大模型驱动打造 API 研发管理与自动化测试全新体验。 Eolink 「AI+API」为 API 带来什么? 输入语义化指令即可生成 API 文档内容; 在 API 文档测试页中可一键生成测试请求数据; 可实现圈定 API 文档范围智能生成测试方案,自动生成流程测试用例,并提供 API 拓扑图展示
272 0
Eolink 全新一代「AI+API」协作管理平台,大模型驱动打造 API 研发管理与自动化测试