导语:产品开发上线前总是避不开数据埋点和API接口,但是到底什么是API呢?API接口有什么用?我们常见的用到的API接口又有哪些呢?产品经理为啥一定要懂API呢?作为PM,不一定需要知道怎么做接口,但一定要看得懂接口文档,那接口文档怎么看呢?学会了API接口又该如何运用呢?今天带大家了解一下吧。
说到开发平台就一定离不开接口,作为PM,我们不需要对接口了解的特别细。只需要知道接口是什么,有什么用,有哪些要素就行。
首先接口是什么
应用程序接口(API:Application Program Interface),是一组定义、程序及协议的集合,通过 API 接口实现计算机软件之间的相互通信。 接口是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
接口有什么用
在日常开发过程中,前后端有数据交互时,前端开发同学都会问后端询问接口,而不需问/关注具体的实现逻辑,高效便捷。
例如APP/物流上需展示天气信息,那么开发同学直接接入对应的天气/物流查询接口就行此外,接口的开放让许多第三方应用可以快速、轻松实现更多功能,如第三方支付、分享组件等等。
常见的API接口有哪些
1.硬件接口
生活中我们经常会接触接口,最常见的就是HDMI 接口和 USB 接口,而且我们知道接入某个接口就能实现某种功能。例如笔记本电脑可以通过 HDMI 接口连接电视,将画面同步显示到电视上;Switch 等游戏设备也可以通过 HDMI 接口连接电视,实现在电视上玩游戏。大多数人并不需要知道 HDMI 接口是怎么实现的,只需要接入之后能干什么就行。
2.程序接口
也就是我们今天要说的API接口,全名application program interface。其实从实际意义上讲程序的接口也和硬件一样,将内部实现的功能封装起来,像一个盒子一样只留出一个口子,人们接入这个口子就能使用这个功能。调用的人可以很方便使用这些功能,并且可以不需要知道这些功能的具体实现过程,接口API 就是按照作者规定的流程去调用这些功能。实际开发中,当前端和后端有数据交互时,前端人员都会直接向后端询问接口写好了没,而不会问他具体的怎么实现的。
举个例子:我们去点餐吃饭
我们到商场店里吃饭,现在基本上都是扫码点餐;首先扫描二维码进入页面,输入就餐人数,然后劈里啪啦一顿点餐并提交订单。点完后,服务员会跟你核对菜单,然后同步到后厨,最后我们就坐等上菜。
例子中的扫码点餐过程就可以看成是API 接口的工作过程,一个点餐的 API 接口,通过选中菜品(输入参数),最后服务员上的一道道菜(输出数据),这过程就是点餐API 接口的作用。来吃饭的顾客是接口的调用者,接口的提供者就是商家。大多数接口一定要有输入和输出,但是严格意义上不是这样的,没有输入也有输出。
接口是数据传递是一种表现。说到底API的作用就是数据传输。
产品经理懂API的好处:
1、明确各个系统之间的数据流转,特别是功能系统的产品经理,只有在知道了功能设计的目的、需要对外提供什么样的接口服务,需求设计阶段才能够考虑得更加全面;
2、掌握开发总体工作量,而不局限于功能;另外,在安排项目计划时能够考虑到与周边系统联调的时间,计划安排才会更加合理;
3、识别项目中的关键风险点,特别是一些关键接口、数据量大需要进行大数据压测的接口,需要尽早安排联调和测试,并且对周边配合的项目提出要求。
接口文档有哪几部分构成的
如下图是一个接口文档,它有以下几个部分组成
接口描述:这个接口的作用和意义,以及相关的规则
接口地址:以网址的形式展现,通过发送请求给这个网址来对接口进行交互操作
请求方法:常用的有post和get两种方式,一个是读接口(常用get)一个是写接口(常用post)
请求参数:请求该接口时,需提供的参数,例如参数属性:名称、支付方式、是否必填等
返回参数:接口正常响应后,返回的内容
错误代码:接口请求失败后,返回的错误代码,例如001表示为该用户为黑名单
项目开发需要前端和后端共同完成的,接口文档通常由后端定义并编写接口文档,然后再前后端联调的时候,根据接口文档进行数据交互。接口文档的规范性就方便了前后端工程师有一个统一的文件进行沟通交流开发,项目维护中或者项目人员更迭的时候,方便后期人员查看、维护。
如何运用API接口
最后介绍一下怎么通过浏览器查看接口数据吧。
首先打开任意浏览器(建议使用谷歌),鼠标右击后点击“查看”或者直接按“F12 键”打开发者工具,然后选择"network"—>“XHR”,就会看到很多接口请求,按需找到请求接口,查看对应返回数据即可。
大多数情况下,可以通过接口状态码和消息提示去判断是后端还是前端的问题。但是有些问题比较隐蔽,即使状态码返回为成功的码,但问题依旧存在,这种情况很有可能是后台某细节错误。