数据 API 开发如何快速上手:先了解什么是数据 API 生命周期管理

任何事务都有一个 API 也不例外。上一段视频,我们解释了什么是数据 API?。这段视频,我们来了解一下数据 API 的生命周期管理。

我们把每个数据 API 生命周期,划分为 API 规划、API 开发、API 发布、API 使用和 API 管理等环节。下文对它们分别进行解读。

1,API 规划:任何 API 开发项目前需要从需求搜集开始到规划和设计,生成一个 API 规范,该规范描述了接口支持的方法和操作以及任何技术约束。

在确定 API 需求后,开发团队可以根据命名规则,体系结构和要使用的特定协议,做出明智的设计决策。与业务人员确定 API 应该公开哪些服务和功能,记录特定的业务需求,并输出为功能和非功能的全面需求文档。

2,API 开发:通常由一个独立的、专用的 API 开发团队完成开发。整个团队需要协作访问和维护 API,都享有查看 API 代码、文档和测试文件并与之交互的权限;可以更轻松地创建文档,测试用例,实现全面的搜索和版本控制,也有助于授权开发人员根据条件(如项目和版本)来定位 API。

随着低代码 API 开发平台的出现,一个人开发 API 也不是什么难事。以麦聪 DaaS 平台为例,该平台封装了 API 开发能力,用户只需在 Web 界面上选库选表,设定请求参数、返回参数几分钟即可完成一个 API 开发。对于复杂的 API 查询逻辑,聪 DaaS 平台也会提供自定义 SQL 写查询逻辑的模式,满足用户复杂的 API 需求场景。

3,API 发布:完成 API 开发之后必须测试每个迭代功能、性能和用户接受度,将不满意的测试结果反馈给开发人员,再进一步改进 API 代码。直指测试毫无问题,就可以发布 API,发布之后的 API 根据自定义目录形成 API 市场,可以对内外部提供数据服务。

4,API 使用:在选择使用某个 API 前,用户需要向管理员申请。审批通过后,申请者拿到 API 的调用地址和请求示例之后才能正常使用。以麦聪 DaaS 平台为例,用户可以通过所开发的 API 直接查看(导出 CSV 或 EXCEL 文档)、下载数据或调用数据,还可以向他人分享 API。分享 API 时,需要先从权限校验接口当中获取 apiToken 后方可获取到数据,还可以根据用户需求设置分享参数、有效天数和下载次数等。

5,API 管理:包括 API 的查看/下线/复制/修改/删除等。用户可以将 API 下线之后进行扩展和更新 API 等操作以提高业务价值,可以监测每个 API 的用户使用情况。随着业务需求的变更,每个 API 都会面临着不断优化,直到用新版本淘汰或被删除。

例如,有些 API 已经几个月甚至更久没有使用过了,仍托管在基础结构中空耗资源和成本。那么这类 API 就完成了自己的生命周期。