当前位置:首页 > 软件测试 > 正文内容

接口文档

一、示例:

 

image.png


1.1:通过登录界面登录百度流程:

如上图:我们在界面的登陆框输入正确的用户名和密码,点击登录,登录成功。

1.2:程序内部流程:

1)前端发送请求到服务端,

2)服务端收到请求去数据库查数据,发现有这个帐号,密码也正确

3)服务端返回给前端登录成功,以及该帐号下的数据

4)前端解析数据,进入登录成功界面,展现该帐户的内容

 

1.3:开发过程可能出现的问题:

如若上描述,服务端收到前端请求的时候,要解析出用户名和密码。

那么问题来了:

如上图,前端美眉认为:用户名这个参数要用user指代,密码这个参数要用pwd指代。

如上图,RD小哥哥认为:用户名这个参数要用username指代,密码这个参数要用password指代。

然后:前端传请求带参数user=桃夭queen、pwd=Ilovetest后端收到请求要提取username和password这两个参数的值,发现没有这两个字段,直接返回错误。

再然后RD小哥哥跑去找前端美眉,你没给我传参数。然后balabala。。。。

最终:两个人确定参数名称,按规则进行参数传递。OMG,接口终于可以跑通了。

 

这还只是一个参数,实际上每个接口都会有很多参数。这就会出现前端美眉和RD小哥哥不停的跑来跑去进行交流。而且他们两个人定义好了,其它同学在调用这个接口的时候理解又不一致,我们测试的时候也要找不同的RD去问各种参数情况这沟通成本太太太高了

 

综上所述:要有一个统一的接口文档,来指定参数名称、参数类型、参数取值范围、参数含义等等。

 

二、接口文档的作用:

1、项目开发过程中:前后端RD要有一个统一的文档进行沟通交流

2、项目维护中:可以随时查看、维护

项目上线了,我新增了一个功能,要调用这个接口或修改这个接口,这个时候就可以查看接口文档明确接口情况。

3、项目人员变更:方便后期人员查看、维护

(1)项目A是桃夭queen负责测试的,一个星期后这一期测试完成,桃夭queen被调去负责其它项目了。调来了猪猪同学负责这个项目,接口功能变更需要测试。猪猪的心理:“天啊,文档也没有,记录也没有,啥也没有,啥也不知道,我在哪里,我在干嘛”。要重新找RD明确接口情况,时间和沟通成本超高。

(2)RD小熊负责开发项目A,一年后离职啦。RD小马入职负责这个项目。新增需求,开发的过程中小马“这块也没有文档,看代码这个接口没有地方调用,冗余了,我优化下,把它干掉吧。”小马勤奋一下然后悲剧啦。。。。程序功能不可用啦。这超级超级麻烦啊。

4、作为接口测试的依据。

没有接口文档,不知道怎么拼接URL,不知道怎么确定参数,没有办法进行测试。

 

三、接口文档组成

1、接口说明接口干嘛的,有什么功能

2、接口url发请求、拼参数要用

3、请求方法get/post

4、请求参数:参数名称、类型、长度、是否必填、参数说明

5、返回值:格式,参数名称、类型、长度、是否为空、参数说明

6、错误码针对不同的错误情况,要有对应的错误码和提示文案。

 

四、接口文档举例

接口地址:http://v.juhe.cn/toutiao/index

返回格式:json

请求方式:get/post均可

请求示例:http://v.juhe.cn/toutiao/index?type=top&key=APPKEY

接口备注:返回头条,社会,国内,娱乐,体育,军事,科技,财经,时尚等新闻信息

求参数说明:

 

image.png


返回参数说明:

 {    "reason": "成功的返回",    

"result": {        

"stat": "1",        

"data": [    {"uniquekey": "6c4caa0c3ba6e05e2a272892af43c00e",

"title": "杨幂的发际线再也回不去了么?网友吐槽像半秃",        

"date": "2017-01-05 11:03",        

"category": "yule",        

"author_name": "腾讯娱乐",        

"url": "http://mini.eastday.com/mobile/170105110355287.html?qid=juheshuju",        

"thumbnail_pic_s": "http://03.imgmini.eastday.com/mobile/20170105/20170105110355_806f4ed3fe71d04fa452783d6736a02b_1_mwpm_03200403.jpeg",        

"thumbnail_pic_s02": "http://03.imgmini.eastday.com/mobile/20170105/20170105110355_806f4ed3fe71d04fa452783d6736a02b_2_mwpm_03200403.jpeg",        

"thumbnail_pic_s03": "http://03.imgmini.eastday.com/mobile/20170105/20170105110355_806f4ed3fe71d04fa452783d6736a02b_3_mwpm_03200403.jpeg"    }, ...]}}

错误码:

 

image.png


扫描二维码推送至手机访问。

版权声明:本文章来源于网络,版权归原作者所有,如果本站文章侵犯了您的权益,请联系我们删除,联系邮箱:luxd@aliyun.com,感谢支持理解。


本文链接:https://luxd.cc/post/104.html

“接口文档” 的相关文章

淘宝购物车的测试点有什么?

淘宝购物车的测试点有什么?

1.界面测试打开淘宝购物车页面后,页面的布局是否合理,是否完整。不同卖家的商品在不同的table区域显示,区分明显。页面的功能按钮可以正常显示。商品的最下方显示失效宝贝。页面的最低端显示“你可能喜欢”向下滑动页面,在购物车顶端展示“购物车”。购物车中如果存在有商品降价、库存不足、限购件数等,在商品详...

软件测试(mark)

软件测试(mark)

一、什么是软件测试最常见的理解是:软件测试就是找BUG,发现缺陷我的理解:测试产品是否满足用户的需求。二、测试和研发的区别?难度小?专业度高?然后工资会低一点吧1、测试和调试的区别调试:研发人员操作,确保程序执行结果正确,调试一般在开发阶段测试:研发人员和测试人员共同完成,测试贯穿软件生命周期三、软...

如何对人工智能软件进行冒烟测试?

如何对人工智能软件进行冒烟测试?

我们在进行普通软件测试的时候,第一步是要进行冒烟测试,那么在测试人工智能软件的时候第一步是要做什么呢?其实同样是要做冒烟测试,本文就通过两步给大家介绍怎样做AI软件的冒烟测试一、第一步------------了解冒烟测试的作用目标掌握冒烟测试在软件测试中的作用步骤1.开发提测软件版本2.测试根据冒烟...

三分钟教会你如何编写完整的测试用例

三分钟教会你如何编写完整的测试用例

对于新人入门而言.大家可能总感觉测试的用例设计不是很合理.接下来简单跟大家聊聊如何在工作中设计测试用例,让自己的工作效率能快速提高对于测试一套完整的测试用例,我们在书写过程中需要对用例都从下列五个维度进行考虑1.测试计划首先,根据用户需求报告中关于功能要求和性能指标的规格说明书,定义相 应的测试需求...

接口测试神器 Jmeter 如何实现测试关联

接口测试神器 Jmeter 如何实现测试关联

小白必看,接口测试神器 Jmeter 如何实现测试关联 前言:三四月份赶上跳槽高峰期,面试中,接口测试部分的关联是经常被提及的知识点之一,经常有同学因此错失良机,“关联”可谓是重中之重了,今天就写一篇关于Jmeter关联的文章,以作备忘。所谓关联,通俗的讲,就是一个请求...

技能的笔记分享

技能的笔记分享

一、Linux必备知识linux作为现在最流行的软件环境系统,一定需要掌握,目前的招聘要求都需要有linux能力。二、Shell脚本掌握shell脚本,包括shell基础与应用、shell逻辑控制、shell逻辑函数等。三、互联网程序原理自动化必由之路:前端开发基础知识以及互联网网络必备知识。四、M...