??技术活，该赏

??点赞 ?? 收藏 ?再看，养成习惯

PC端左侧加我微信，进 群，有送书等更多活动！

文章目录

• 零、前言
• 一、API 研发管理
• • 1.1、什么是API研发管理
  • 1.2、痛点
  • 1.3、解决方案
• 二、搭建部署及不同角色的关注点介绍
• • 2.1、下载安装
  • 2.2、开发管理
  • • 创建项目及从第三方导入api
    • api变更通知
  • 2.3、测试管理
  • • 编写测试用例
    • 批量测试
    • 不同环境的测试
    • • 请求地址前缀
      • 额外请求头部
      • 额外Form-data请求参数
      • 切换环境
  • 2.4、项目管理
  • • 一键快速生成API接口文档
    • 支持导出指定分组的api文档
    • 统计分析
    • api测试用例 告
• 三、总结
• 四、参考资料
• 五、粉丝福利
• • 粉丝福利1
  • 粉丝福利2

零、前言

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

一、API 研发管理

1.1、什么是API研发管理

你是否认为API管理无非是管理一下API文档（如何把文档写漂亮一点，规范一点），只需要用word文档API描述写一下，要团队协作时，把API文档文件发给前端或测试人员就行r> 其实没这么简单，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 研发管理项目列表页，点击 添加 按钮。

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

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

不同环境的测试

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

创建项目环境：

请求地址前缀

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

额外请求头部

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

额外Form-data请求参数

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

切换环境

如图位置，可切换环境

支持多种导出格式：