当前位置:朝夕网 » 数码科技 » API接口设计,需要注意这4点

API接口设计,需要注意这4点

原则上API接口设计一般出现在开发的详细设计中,但是随着诸多公司建立开放平台,产品经理也逐渐需要能理解API接口,尤其是做平台性的产品,还要学会定义接口。本文就关于产品经理在设计接口中需要定义什么、需

原则上API接口设计一般出现在开发的详细设计中,但是随着诸多公司建立开放平台,产品经理也逐渐需要能理解API接口,尤其是做平台性的产品,还要学会定义接口。本文就关于产品经理在设计接口中需要定义什么、需要注意什么来展开陈述。

看到人人都是产品经理社区已经有关于API接口的相关介绍,因此本文就不做过多的关于API接口概念方面的介绍。

一、了解API的常识

在做接口设计时,如果是新手,建议多参考并了解不同开放平台的接口样式,比如百度、旷视、腾讯等,从中可以发现一些共识;

1. 常用的通信协议

调用第三方平台接口需要进行系统间的通信,目前常用的协议是http和https;简单理解https是http的加密版,可以将用户到服务端请求的信息进行加密,避免因明文传输被截获而获知用户信息。

基于http协议的接口具有轻量级、跨平台、和跨语言的特点,为了适应不同的开发者,目前各个第三方平台都会提供基于各种常用语言的接口形式,因此大多采用http或https协议;举例,百度、科大讯飞:

科大讯飞的物体识别请求URL:http://tupapi.xfyun.cn/v1/currency百度的菜品识别请求URL: https://aip.baidubce.com/rest/2.0/image-classify/v2/dish

笔者查阅了百度、腾讯、旷视、阿里的云平台发现在视觉方面均都采用的是https协议;对于视觉,图片数据本身包含的信息就很丰富,尤其是人脸,因此采用https还是有利于保护用户隐

2. 接口的请求方式

了解接口的请求方式有助于了解用户端和服务端间的交互方式,基于http协议的常用请求方式是post和get;两者的主要区别如下:

字段信息约束条件

字段约束条件是为了保证接口的安全性,这点是产品经理跟业务方沟通达成一致后提供给开发小伙伴的;仍然以上面的菜品识别为例:

图片需要限制文件大小和分辨率大小,文件大小只需要上限,分辨率大小需要包括上限和下限,下限是为了保证算法效果,比如在目标检测中小目标容易检测失败;top_num需要限制下限,不得小于0,不设上限,可以接受算法返回的所有结果;阈值根据格式确定,可以是0-100,可以是0-1;2. 出参

调用接口就会有返回信息,产品需要根据业务需求定义返回的核心字段信息,这次以百度AI开放平台手势识别为例,其中跟业务需求相关的关键字段包括:

result_num、result,即一张图片中识别的手势结果数量,和具体的手势信息;result为json数组,包括手势的类别、手势检测框的位置信息【一般识别类算法底层是检测+识别两步】、和手势类别的置信度;其中result中的一些字段信息,产品可以根据业务需求进行增减,比如目标检测框的位置信息,一般业务不需要就可以省略;三、接口限流

接口限流也是为了保障系统的安全性,因为有时业务方因为业务扩展导致调用量激增,容易引起服务端宕机;限流就类似于电闸的保险丝保证请求量超过接口上限时系统可以拒绝请求或排队,以此保证系统的安全性;

产品经理需要实现对业务充分评估,给出合理评估量,如TPS(每秒处理的请求量);这样既不会造成系统资源的浪费,也保证业务正常运行;

四、接口测试

接口测试虽然是测试小姐姐的工作,测试内容也覆盖众多,但是作为产品可以简单了解以下内容即可,如,

(1)接口可用性,即接口是否可以正常调用,正常返回结果,异常正确处理,正常返回错误码等;

(2)业务需求覆盖,即接口输入输出是否遵循产品需求文档描述;

(3)边界规则遵循,即接口是否满足业务规则和字段约束条件;

(4)性能条件,通常接口上线前需要经过压测达到性能指标才可,包括某并发量下的tps和耗时等;

结语

以上即是本人作为产品经理对于API设计时经常需要和开发、业务讨论的关键点和注意点~~

《如何做一款SDK产品?》

以上就是朝夕生活(www.30zx.com)关于“API接口设计,需要注意这4点”的详细内容,希望对大家有所帮助!

免责声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如有侵权行为,请第一时间联系我们修改或删除,多谢。朝夕网 » API接口设计,需要注意这4点