用友薪福社如何使用 Apifox 打通 API 研发协作流程,找到「管理」与「效率」的新平衡点
关于 用友薪福社
用友薪福社是用友集团旗下成员企业,专注于社会化用工领域,用创想与技术推动中国社会化用工的发展,提供社会化用工整体解决方案,帮助企业建立用工新模式,提升企业人效,解决企业用工难题,实现企业多维度营销领跑,助力企业业绩快速增长。
用友薪福社业务覆盖制造、地产、金融、贸易、零售、IT、互联网、影视文娱及教育等 30+ 行业。未来,用友薪福社将在助力企业业绩增长方向,持续输出更多数智化解决方案。
Apifox 作为国内领先的 API 一体化研发协作平台, 助力用友薪福社提升 API 研发流程效能,大幅提高了开发协作效率和工作质量,实现了多重业务领跑,同时也大大提高了内部协同效率,让研发工作稳定推进。
面临挑战
- API 研发流程管理混乱,各团队流程不统一,开发模式有文档先行也有代码先行,整体 API 开发流程不规范统一。
- 企业内部 API 分享困难,靠离线文档进行分享,效率低下,且易漏传,导致出现版本不统一的情况。
- API 请求参数和返回示例定义的过程中会有大量重复繁琐的工作,后续调整维护起来也比较困难。
Apifox 解决方案
API 研发流程统一,提升效能
通过前期 Apifox 团队与用友薪福社研发团队的调研中,了解到用友薪福社研发团队在开发流程上还没有统一,各种开发模式结合实行,导致 API 研发流程管理较为困难,没有形成标准化的API开发规范和开发流程。
在与研发团队深入沟通后,了解用友薪福社研发团队偏向于先定义 API 文档后实现代码的「API 设计优先」模式,Apifox 的 API 「文档模式」可以帮助研发团队规范 API 文档,同时又帮助团队快速落地「API 优先」的开发模式,快速实现团队内部的 API 开发流程统一,并规范整个 API 开发流程,让 Apifox 成为贯穿团队研发流程的 API 管理工具,助力 API 研发管理流程的效能提升。
统一 API 文档规范,在线分享高效协同
用友薪福社研发团队内部分析 API 文档的方式主要靠离线文档传递,导致经常出现文档传漏传错以及文档版本不统一的情况,同时没有统一规范的文档标准也会导致不同的开发人员各自按照自己的习惯编写文档,让文档的阅读理解成本增加,导致研发团队开发效率降低。
通过 Apifox 的在线 API 文档分享的功能即可解决这些问题。Apifox 的在线文档一键即可生成,可直接在文档中在线调试接口,帮助研发人员提高对接效率,帮助规范 API 文档格式标准的同时,解决了 API 分享困难的问题,对整个团队内部协同效率提升有巨大的帮助。
运用数据模型,释放研发人员生产力
了解到用友薪福社研发团队在 API 请求参数和返回示例定义的过程中会存在大量重复繁琐的定义工作,这既加重了研发人员的工作,又使得后期API文档维护成本剧增,严重拖缓了开发节奏。使用 Apifox 的数据模型功能,能够只需一次定义即可在多个文档中引用,引用后也可以脱离组件单独修改定义内容或同步修改内容到组件中,让多个文档中的定义同步修改,解决了多个接口需要重复定义接口出入参数的繁琐问题,让有限的开发资源得到了更充分的利用,提高了研发团队ROI,节省更多的精力去投入其他研发工作,大大提升了 API 开发效率。
客户收益
- 提升效能:规范了内部 API 的开发流程,统一了团队内的 API 管理工具,提高了 API 研发效能。
- 加强协同:一键式的分享文档,提高了团队内部的协同效率。
- 节省精力:去掉了繁琐重复的定义出入参数工作,使其精力更加专注在了 API 本身的研发。