API接口设计,需要注意这4点
web前端开发
共 3215字,需浏览 7分钟
·
2020-11-08 04:44
一、了解API的常识
1、常用的通信协议
科大讯飞的物体识别请求URL:http://tupapi.xfyun.cn/v1/currency
百度的菜品识别请求URL:https://aip.baidubce.com/rest/2.0/image-classify/v2/dish
2、 接口的请求方式
3、接口响应机制
小结
二、核心业务字段&接口约束
1、 入参
(1)鉴权字段信息
(2)核心业务字段
输入图片,图片支持通常采用base64和URL格式;
top_num,提高接口的通用性,方便用户后续场景扩展,因此支持配置返回菜品数量且排序;
阈值,开放识别阈值,方便用户根据实际识别效果调整,提高准确率;
(3)字段信息约束条件
图片需要限制文件大小和分辨率大小,文件大小只需要上限,分辨率大小需要包括上限和下限,下限是为了保证算法效果,比如在目标检测中小目标容易检测失败;
top_num需要限制下限,不得小于0,不设上限,可以接受算法返回的所有结果;
阈值根据格式确定,可以是0-100,可以是0-1;
2、出参
result_num、result,即一张图片中识别的手势结果数量,和具体的手势信息;
result为json数组,包括手势的类别、手势检测框的位置信息【一般识别类算法底层是检测+识别两步】、和手势类别的置信度;
其中result中的一些字段信息,产品可以根据业务需求进行增减,比如目标检测框的位置信息,一般业务不需要就可以省略;
三、接口限流
四、接口测试
结语
评论