一般网站隐蔽点么么进,关键字查询我的网站怎么做,做设计图的网站,制作介绍的网站应用程序接口 API#xff08;Application Programming Interface#xff09;#xff0c;是提供特定业务输出能力、连接不同系统的一种约定。这里包括外部系统与提供服务的系统#xff08;中后台系统#xff09;或后台不同系统之间的交互点。包括外部接口、内部接口#x…应用程序接口 APIApplication Programming Interface是提供特定业务输出能力、连接不同系统的一种约定。这里包括外部系统与提供服务的系统中后台系统或后台不同系统之间的交互点。包括外部接口、内部接口内部接口又包括上层服务与下层服务接口、同级接口。
本文站在产品经理角度由浅入深讲述接口相关知识如果不想被视为技术大佬眼中什么都不懂的需求搬运工清楚接口的相关知识是很有必要的。
常见 web 接口是 http/https 协议的接口多用于外部系统或前端系统的调用因为此类接口地址要暴露在外部所以必须对接口的安全性做较高程度的校验。还要一种基于开源 rpc 构建的跨系统接口调用接口方案此类主要用于大公司内网各系统间的互相调用此类接口服务治理能力更强接口相应速度更块。以下内容以 http 接口为例展开的讨论。
No.1
接口请求方式类型
常见的 http 请求方式包括get查、post增除此之外还有 put改、delete删等。接口所属类型是由业务决定的。比如你打开淘宝展示的首页内容就需要用到 get 接口获取页面信息你看中了宝贝要下单添加你的收获地址时用的则是 post 接口。而这两种也是其中最常见的两种接口类型
1get 类型接口
格式请求数参数写在网址后面用”?”连接多个参数之间用””连接。
场景get 型接口用于获取信息多用于查询数据如菜单列表展示搜索展示订单查询优惠券查询等需要其他系统返回数据时使用。一般情况下请求的数据量较小返回速度快不过接口是暴露在外面的所以会有一定的风险。
2post 型接口
说明向指定资源位置提交数据如提交表单、上传文件来进行请求post 请求可能会导致新资源的建立。
场景如注册、上传、发帖等功能这种请求数据量大安全性要求高。
其他接口类型如 put改、delete删、patch 等使用频率稍低一些此处不再赘述。
No.2
接口响应机制类型
从返回上区分分为同步接口、异步接口
1同步交互
指发送一个请求需要等待返回然后才能够发送下一个请求有个等待过程
比如登录接口执行登录操作时将用户名、密码、token 等字段加密后通过接口校验需要返回验证结果后才能登录成功。
2异步交互
指发送一个请求不需要等待返回随时可以再发送下一个请求即不需要等待。
如用户领导优惠券只需要将用户的领券行为请求成功资产系统收到请求后异步操作用户发券通过异步的方法执行发券调用方无须等待每个请求的调用结果。
区别一个需要等待一个不需要等待在不影响用户体验的情况下我们的项目开发中一般会优先选择不需要等待的异步交互方式。
哪些情况建议使用同步交互呢比如用户登录、银行的转账系统对数据库的保存操作等等都会使用同步交互操作其余情况都优先使用异步交互。
No.3
接口的触发形式类型
1分发接口
一个系统产生新数据的时候就分发给其它系统也可以是多个。
中台系统的核心思想是高内聚、低耦合所以分发接口的使用场景还是比较多的。比如有一个主渠道系统来管理所有的渠道数据而渠道数据是其他系统如商品系统、促销系统经常要使用到的信息。所以一旦出现新的渠道或者发生渠道变更需要分发给其他所有对接了各个系统实现对最新渠道的功能支撑。
2订阅接口
一个系统在需要的时候调用其他系统的接口进行数据订阅。
比如订单系统生成订单时因为很多外部系统可能需要及时获取订单状态信息。而订单系统也不知道要分发给哪些系统这时候一般会将订单推送至特定的消息队列比如 KFK其他由需要跟进订单状态的的系统订阅 KFK 消息后可以即使获取订单完成信息进行触发下一个动作。
No.4
其他 API 接口基本组成
在既定的业务下接口请求类型、响应机制等确定后再以淘宝详情API为例了解下接口的其他组成内容。
1应用场景
顾名思义此接口适用于的场景明确接口的业务用途。
2入参及出参
公共参数
请求参数
请求参数num_iid652874751412is_promotion1
参数说明num_iid:淘宝商品 IDis_promotion:是否获取取促销价
响应参数
{item: {num_iid: 652874751412,title: 北欧轻奢布艺沙发 小户型简约现代客厅ins风网红款三双人订制沙发,desc_short: ,price: 480,total_price: ,suggestive_price: ,orginal_price: 480,nick: 惜情yqq1127,num: 1531,detail_url: https://item.taobao.com/item.htm?id652874751412,pic_url: //img.alicdn.com/imgextra/i4/2568161054/O1CN01aYBriY1Jem9UDtt9e_!!2568161054.jpg,brand: #0 工厂,brandId: ,rootCatId: ,cid: 50020632,desc: div \n div \n img src\http://img.alicdn.com/imgextra/i3/2568161054/O1CN01LFmSOU1Jem9QOjMPb_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i3/2568161054/O1CN014vyOOT1Jem9DpHz3Y_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i1/2568161054/O1CN01B3PpsA1Jem9N8V7uf_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i2/2568161054/O1CN015JbyeY1Jem9MZshUt_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i1/2568161054/O1CN01HXSoxx1Jem9RvgzHN_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i3/2568161054/O1CN01IEultA1Jem9MdEx8R_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i3/2568161054/O1CN0176K98O1Jem9QOjE69_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i4/2568161054/O1CN013Pxp1O1Jem9RvgeTv_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i1/2568161054/O1CN01SfyZ8M1Jem9QOi1Gx_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i4/2568161054/O1CN01bb1POa1Jem9Sdgve2_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i3/2568161054/O1CN018Eo9dV1Jem9KV0y79_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i1/2568161054/O1CN01vuEofr1Jem9Nzy9xY_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i4/2568161054/O1CN01qw9sAi1Jem8wkNKpy_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i1/2568161054/O1CN01HeFhFw1Jem8rLnjBY_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i2/2568161054/O1CN01SNgjoi1Jem9QOil15_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i2/2568161054/O1CN01RXf3RA1Jem9DpHVwj_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i4/2568161054/O1CN01gZmZjt1Jem9ISThgm_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i2/2568161054/O1CN01YL0FHM1Jem9PQTjX9_!!2568161054.jpg\ /\n img src\http://img.alicdn.com/imgextra/i4/2568161054/O1CN01UhsEhZ1Jem8yvJIhZ_!!2568161054.jpg\ /\n /div \n /divimg src\https://www.o0b.cn/i.php?t.pngridgw-3.65278c2d99cd9p1939419568k79571t1697090609\ style\display:none\ /,item_imgs: [{url: //img.alicdn.com/imgextra/i4/2568161054/O1CN01aYBriY1Jem9UDtt9e_!!2568161054.jpg},{url: //img.alicdn.com/imgextra/i3/2568161054/O1CN01kjOfNb1Jem9DmWn8Y_!!2568161054.jpg},{url: //img.alicdn.com/imgextra/i1/2568161054/O1CN01HoB9ha1Jem9DmWn8r_!!2568161054.jpg},{url: //img.alicdn.com/imgextra/i4/2568161054/O1CN011PjP2P1Jem9MXEUFT_!!2568161054.jpg},{url: //img.alicdn.com/imgextra/i3/2568161054/O1CN01KUfBFL1Jem9KTTMn1_!!2568161054.jpg}],item_weight: ,post_fee: ,freight: ,express_fee: ,ems_fee: ,shipping_to: ,video: {url: http://cloud.video.taobao.com/play/u/p/1/e/6/t/1/428224913062.mp4},sample_id: ,props_name: 31480:14306495906:几人坐:脚踏90*60*48cm;31480:14306495907:几人坐:双人165*95*67cm;31480:14306495908:几人坐:三人210*95*67cm;31480:14306495909:几人坐:单人100*95*67cm;31480:21480914361:几人坐:四人位240*95*67cm;31480:21480914362:几人坐:大四人320*95*76cm;31480:1387571900:几人坐:3米贵妃沙发;31480:32527954:几人坐:定制尺寸;1627207:28321:颜色分类:乳白色 尺寸颜色可定制;1627207:28321:颜色分类:乳白色 尺寸颜色可定制;1627207:28321:颜色分类:乳白色 尺寸颜色可定制;1627207:28321:颜色分类:乳白色 尺寸颜色可定制;1627207:28321:颜色分类:乳白色 尺寸颜色可定制;1627207:28321:颜色分类:乳白色 尺寸颜色可定制;1627207:28321:颜色分类:乳白色 尺寸颜色可定制;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,prop_imgs: {prop_img: [{properties: 1627207:28321,url: http://img.alicdn.com/imgextra/i1/2568161054/O1CN017GTZ4h1Jem9Qra1ap_!!2568161054.jpg}]},props_imgs: {prop_img: [{properties: 1627207:28321,url: http://img.alicdn.com/imgextra/i1/2568161054/O1CN017GTZ4h1Jem9Qra1ap_!!2568161054.jpg}]},property_alias: ,props: [{name: 品牌,value: #0 工厂},{name: 型号,value: 520},{name: 材质,value: 木},{name: 木质材质,value: 松木},{name: 面料,value: 绒布},{name: 风格,value: 北欧},{name: 几人坐,value: 脚踏90*60*48cm 双人165*95*67cm 三人210*95*67cm 单人100*95*67cm 四人位240*95*67cm 大四人320*95*76cm 3米贵妃沙发 定制尺寸},{name: 颜色分类,value: 乳白色},{name: 填充物,value: 海绵},{name: 结构工艺,value: 木质工艺},{name: 否可定制,value: 是},{name: 沙发组合形式,value: U形},{name: 否可拆洗,value: 是},{name: 适用对象,value: 成年人},{name: 是带储物空间,value: 否},{name: 产地,value: 上海},{name: 地市,value: 上海市},{name: 区县,value: 奉贤区},{name: 是组装,value: 否},{name: 出租车是可运输,value: 否},{name: 填充物硬度,value: 软},{name: 款式定位,value: 经济型}],total_sold: -1,skus: {sku: [{price: 480,total_price: 0,orginal_price: 480,properties: 31480:14306495906;1627207:28321,properties_name: 31480:14306495906:几人坐:脚踏90*60*48cm;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 200,sku_id: 4881047531343},{price: 1688,total_price: 0,orginal_price: 1688,properties: 31480:14306495907;1627207:28321,properties_name: 31480:14306495907:几人坐:双人165*95*67cm;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 135,sku_id: 4881047531344},{price: 2088,total_price: 0,orginal_price: 2088,properties: 31480:14306495908;1627207:28321,properties_name: 31480:14306495908:几人坐:三人210*95*67cm;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 196,sku_id: 4881047531345},{price: 968,total_price: 0,orginal_price: 968,properties: 31480:14306495909;1627207:28321,properties_name: 31480:14306495909:几人坐:单人100*95*67cm;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 200,sku_id: 4881047531346},{price: 2388,total_price: 0,orginal_price: 2388,properties: 31480:21480914361;1627207:28321,properties_name: 31480:21480914361:几人坐:四人位240*95*67cm;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 200,sku_id: 5039985183001},{price: 3188,total_price: 0,orginal_price: 3188,properties: 31480:21480914362;1627207:28321,properties_name: 31480:21480914362:几人坐:大四人320*95*76cm;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 200,sku_id: 5039985183002},{price: 3400,total_price: 0,orginal_price: 3400,properties: 31480:1387571900;1627207:28321,properties_name: 31480:1387571900:几人坐:3米贵妃沙发;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 200,sku_id: 5039984824000},{price: 3000,total_price: 0,orginal_price: 3000,properties: 31480:32527954;1627207:28321,properties_name: 31480:32527954:几人坐:定制尺寸;1627207:28321:颜色分类:乳白色 尺寸颜色可定制,quantity: 200,sku_id: 5039985183003}]},seller_id: 2568161054,sales: 0,shop_id: 567158267,props_list: {31480:14306495906: 几人坐:脚踏90*60*48cm,31480:14306495907: 几人坐:双人165*95*67cm,31480:14306495908: 几人坐:三人210*95*67cm,31480:14306495909: 几人坐:单人100*95*67cm,31480:21480914361: 几人坐:四人位240*95*67cm,31480:21480914362: 几人坐:大四人320*95*76cm,31480:1387571900: 几人坐:3米贵妃沙发,31480:32527954: 几人坐:定制尺寸,1627207:28321: 颜色分类:乳白色 尺寸颜色可定制},seller_info: {nick: 惜情yqq1127,item_score: 4.98268,score_p: 4.98268,delivery_score: 4.98268,shop_type: ,user_num_id: 2568161054,sid: null,title: ,zhuy: https://shop567158267,cert: null,open_time: ,credit_score: null,shop_name: 现代布艺沙发},tmall: true,error: ,location: 江苏南通,data_from: Ha,has_discount: false,is_promotion: false,promo_type: null,props_img: {1627207:28321: http://img.alicdn.com/imgextra/i1/2568161054/O1CN017GTZ4h1Jem9Qra1ap_!!2568161054.jpg},format_check: ok,desc_img: [http://img.alicdn.com/imgextra/i3/2568161054/O1CN01LFmSOU1Jem9QOjMPb_!!2568161054.jpg,http://img.alicdn.com/imgextra/i3/2568161054/O1CN014vyOOT1Jem9DpHz3Y_!!2568161054.jpg,http://img.alicdn.com/imgextra/i1/2568161054/O1CN01B3PpsA1Jem9N8V7uf_!!2568161054.jpg,http://img.alicdn.com/imgextra/i2/2568161054/O1CN015JbyeY1Jem9MZshUt_!!2568161054.jpg,http://img.alicdn.com/imgextra/i1/2568161054/O1CN01HXSoxx1Jem9RvgzHN_!!2568161054.jpg,http://img.alicdn.com/imgextra/i3/2568161054/O1CN01IEultA1Jem9MdEx8R_!!2568161054.jpg,http://img.alicdn.com/imgextra/i3/2568161054/O1CN0176K98O1Jem9QOjE69_!!2568161054.jpg,http://img.alicdn.com/imgextra/i4/2568161054/O1CN013Pxp1O1Jem9RvgeTv_!!2568161054.jpg,http://img.alicdn.com/imgextra/i1/2568161054/O1CN01SfyZ8M1Jem9QOi1Gx_!!2568161054.jpg,http://img.alicdn.com/imgextra/i4/2568161054/O1CN01bb1POa1Jem9Sdgve2_!!2568161054.jpg,http://img.alicdn.com/imgextra/i3/2568161054/O1CN018Eo9dV1Jem9KV0y79_!!2568161054.jpg,http://img.alicdn.com/imgextra/i1/2568161054/O1CN01vuEofr1Jem9Nzy9xY_!!2568161054.jpg,http://img.alicdn.com/imgextra/i4/2568161054/O1CN01qw9sAi1Jem8wkNKpy_!!2568161054.jpg,http://img.alicdn.com/imgextra/i1/2568161054/O1CN01HeFhFw1Jem8rLnjBY_!!2568161054.jpg,http://img.alicdn.com/imgextra/i2/2568161054/O1CN01SNgjoi1Jem9QOil15_!!2568161054.jpg,http://img.alicdn.com/imgextra/i2/2568161054/O1CN01RXf3RA1Jem9DpHVwj_!!2568161054.jpg,http://img.alicdn.com/imgextra/i4/2568161054/O1CN01gZmZjt1Jem9ISThgm_!!2568161054.jpg,http://img.alicdn.com/imgextra/i2/2568161054/O1CN01YL0FHM1Jem9PQTjX9_!!2568161054.jpg,http://img.alicdn.com/imgextra/i4/2568161054/O1CN01UhsEhZ1Jem8yvJIhZ_!!2568161054.jpg],shop_item: [],relate_items: []}, 入参是接口请求所需要的变量参数其中包括必填参数和非必填参数非必填并非是可以忽略的比如上面的入参中签名类型为非必填如果未传此参数则默认此签名类型为 MD5如果使用的并非此类签名类型则此项为必填项。如果是普通订单查询入参时间非必填则返回结果是用户全部订单或者用户特定时间订单的区别。
3错误码
接口请求并非每次都能成功所以在接口开发时会对可能失败的情况进行错误码区分在接口联调时可以根据返回的错误码快递定位问题。如果错误码不够全面那在接口调用失败的时候需要反复定位降低开发效率。 No.5
接口安全性校验
接口完成业务逻辑开发后接下来要考虑的就是安全性问题了接口的安全性问题主要来源于几方面考虑
1请求来源是否合法
即接口的伪装攻击因为接口是对外的在公网环境中接口地址是暴露的收到的请求有可能是恶意非法请求如果真的是合法请求也需要知道这个请求的来源同时这个请求来源不能否认。这里引入“签名”的概念以及签名的防伪装及抗否认性特性。
近些年各大企业强制使用 https 替换掉原有的 http 接口正是因为 https 所使用的的证书安全性更高。
2请求是否会被篡改返回数据可能会被截取
因为接口是对外的所以接收请求和返回数据的时候是不可能使用明文方式传输的否则一旦被恶意截取会造成极大风险。所以请求数据及返回数据都是需要加密的这样即使数据被截取也不用泄露数据的内容。这里介绍几种现在常见的加密方法。
DESData Encryption Standard数据加密标准速度较快适用于加密大量数据的场合
3DESTriple DES是基于 DES对一块数据用三个不同的密钥进行三次加密强度更高
RSA非对称加密由 RSA 公司发明是一个支持变长密钥的公共密钥算法需要加密的文件块的长度也是可变的既可以实现加密又可以实现签名。
如果是用户账号相关现在会使用 token 加密用户信息用户请求身份信息时服务端会分配 token 存在缓存中后续请求会将 token 与时间戳一起打包加密这样即使请求数据被截获因为不知道 token 的值数据也不会被解析出来。
3如何防范接口的重放攻击
就是把你的请求原封不动地多次发放请求都会通过验证进入到正常逻辑中会造成服务端接口拥堵并且会造成实际损失。
防重放一般需在请求参数加上 时间戳 随机数通过时间戳确保接口是最新的请求而随机数相同则可以认定为是重放攻击。
No.6
接口性能相关
如果是访问量比较大的接口再上线前肯定需要进行压力测试。因为普通的开发自测和生产模拟是不能推算出高并发时候接口是否可正常运行。
1TPS
Transaction Per Second 每秒系统处理的交易或事物的数量衡量系统处理能力的重要指标。
2RT
响应时间从客户端发送一个请求开始到客户端接收到从服务器返回的响应结果结束所经历的时间包括请求发送时间网络传输时间和服务器处理时间三部分。
3吞吐量
指的是在一次性能测试过程中网络上传输的数据量的总和。
用户的响应时间自不必说时间太久伤用户体验及时处于高并发期用户的响应时间依然需要控制到最低一般不超过 5s
tps 则是高并发的指标一般提供服务的接口需要考虑到最极端情况下的并发数这些数量一般来自于运营的活动策划和往期的数据趋势预估以此为依据保证自己的接口可以支持最高的并发数而验证这些使用的一般是压力测试。如正常情况下压测时 tps 可以达到 2000 时接口正常就可以保证 2000 的实际并发。
No.7
接口需要做哪些测试
接口测试其实是白盒测试首页要明确系统的能力输出明确服务覆盖是否满足需求。以业务逻辑推接口参数。
1入参不符合要求需要有明确错误码报错信息和日志方便问题复现与定位。
2如果另有参数处理逻辑的链路也需要一并验证如购买网易云音乐会员订单生成后会去权益系统加权加权成功后会有短信通知用户但加权接口和订单信息中都没有用户手机号所以虽然入参中没有用户手机号但需要根据用户的 username 去查询手机号并执行短信发放的操作。
其他验证目标如代码覆盖率是否达到要求、性能指标是否满足要求、安全指标是否满足要求则是更为专业性的测试指标了。
