前言:
对于很多产品小白或求职者而言,API接口是一个产品和研发领域的专业术语,大家可能在很多篇文章或者PRD中都已经有接触过API接口的概念。
实际上,接口的应用已经非常广泛和成熟,这个概念主要活跃在公司内部的各系统之间的衔接和对接以及公司间合作的场景。今天老虞就和大家一起简单聊聊API,相信你们看完文章后,也会对API接口更加深入。
· ONE ·
什么是API接口?
API,全称是Application Programming Interface,即应用程序编程接口,我们日常中习惯简称为“接口”。
其实接口这个词大家应该不会陌生,比如我们平时比较常用的“USB接口”,就是用来存储和传输数据用的;那什么是API呢,API事实上是在内部预先定义了函数,能够使开发人员无须明白API内部实现的机制,就能够实现某一个功能。
老虞给大家举个简单的栗子,比如说你要实现一个手机注册的功能,那么相应地后台工程师就需要提供一个手机注册的接口,前端开发人员在调用接口实现功能的时候,只需按照既定的规则进行请求即可,不需要去理解该功能的实现逻辑。有了这么一个机制,就使得开发人员间的协作变得非常简洁、高效。
所以,你可以简单地理解为“接口决定了功能”。
· TWO ·
为什么会有API接口?
1.项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2.项目维护中或者项目人员更迭的时候,方便后期人员查看、维护
背景:
因为我们的业务系统涉及多方多面,如果要一个公司或者一个系统把所有业务都做完,那未免工作量太大了。并且如果其他系统或公司有更好的运算逻辑,那我们在设计功能的时候就可以考虑利用接口进行开发。
核心需求:
利用现有接口可以降低开发成本,缩短开发成本。
老虞举栗子:
比如老虞做了一个打车的APP,现在老虞需要在页面上展现地图的功能,对公司而言,新做地图功能未免成本过高,那我们可以在高德开放平台或者百度地图的开放平台,找到地图API,这样的话我们只需要购买高德的服务,部署调用高德地图API,这样就可以快速在我们页面上线地图功能了。
· THREE ·
怎么看懂API文档?
API 接口文档一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。
1.接口描述:简单描述接口的逻辑和作用。
2.接口地址:接口的正式 url 和接口测试的 url,需求方通过调用接口 url,获取响应内容。
3.请求方法:一般来说,接口最常见的请求方法为 GET 和 POST 两种方式,即读接口和写接口。通过这两种方式,实现对数据的增删查改。增删改本质都是写的动作。
4.请求参数:即需要请求的字段名的名称和规则:都是哪些字段,字段的类型是什么,是否必填字段等等。
5.响应内容:接口返回的字段名称和规则。注意:大部分开发往往不会把所有的字段罗列,只会列出比较重要的字段。当你发现,接口文档中没有你需求的字段,别着急找开发,可以看下实例中,有没有需求的字段。
6.错误代码:对接口的错误用代码进行归类,以便能快速找到错误原因,解决问题。
7.实例实际:调用时的响应的内容。
总结
很多新人在理解API 的时候有一个误区:会单纯的以为API就是帮助研发人员将产品通用功能的代码复制到自己的产品上的一个接入口。其实API 是连接两个产品的桥梁,并不是直接复制代码,而是你的产品通过API 接口使用了一些通用的功能,用户通过你的产品使用其他平台上的功能。
API 接口的报价也是通过用户使用接入功能的次数或者使用年限来计算的。
API就是能够轻松实现和其他软件组件的交互;API接口就是实现不同组件之间交互地方;API协议就是规定不同组件交互时候的规则,API端点是在同一接口提高不同的功能。
对于产品经理来说,熟悉官方API文档,是非常有必要的一件事情。无论是从产品设计的角度,还是对于和开发的沟通协调,以及产品经理自身修养的提高等,都会有不少的帮助,可以让你从更高的纬度去俯视整个产品。最后,希望这篇文章对你有所帮助。欢迎留言交流沟通。