测试实战干货：怎么根据接口文档写接口？

Posted 2021-08-27 小马哥说测试

一、为什么要有接口文档？

　　没有接口文档的接口测试都是在抓瞎~前面的接口测试重点讲了协议，也讲了fiddler模拟接口请求，估计大部分还是不太懂怎么下手测试。这里小编专门拿出接口文档来做接口测试参考(估计很多测试小伙伴没见过接口文档)。

　　举个栗子：前端开发和后端开发口头商量：“成功返回0，失败返回1”。结果最后开发出来，测试MM发现，后端成功返回1，失败返回0。于是两个开发开始撕逼大战，谁都不承认自己的错了。谁都不愿低头去认错，因为空口无凭啊，当初拍脑袋商量的事情，过两天就忘了。为了避免在这种小事上扯皮，浪费不必要的时间，于是就有了接口文档。

　　白纸黑字写的清清楚楚，测试也有参考性。

　　二、短信接口需求

　　一切功能开发都离不开需求文档，一切测试也离不开需求文档，先看看这个短信接口的需求，如下：

　　工作方式

　　· 双方通过HTTP方式交互数据，第三方可以简单的“name=value”方式发送提交内容或响应请求内容。即通过HTTP的GET/POST方式交换。

　　· 另外双方需要保证数据传输的完整性和安全性，每次发送请求都有响应(响应返回格式为纯文本)，安全验证目前采用用户名和密码的方式。

　　字符编码

　　· 服务器接收数据可以是GBK编码字符,默认接收数据是GBK编码。

　　· 请求响应返回内容是GBK编码。

　　响应格式

　　· 所为响应即每次向服务器提交请求后返回值

　　· 响应值格式为纯文本状态码,例如发送成功后返回0

　　三、发送短信接口文档

　　功能:发送短信

　　HTTP请求方式:GET/POST

　　请求URL http://host:8080/sms/mt.jsp?cpName=用户账号&cpPwd=用户密码&phones=号码&msg=内容

　　请求参数：

　　返回结果：

　　参数名称 类型 描述

　　返回描述 String 发送成功返回0，如果发送不成功，则返回“ERROR&&对应的错误信息”

　　请求示例

　　GET http://host:8080/sms/mt.jsp?cpName=用户账号&cpPwd=用户密码&phones=号码&msg=内容

　　(注：一般这种提交参数的接口用post方式，虽然get也可以提交，但是比较傻逼，要是遇到开发用get方式提交数据，可以抽他了。)

　　四、批量发送短信接口文档

　　功能:批量发送短信

　　HTTP请求方式:POST

　　请求URL

　　http://221.122.112.136:8080/sms/batchmt.jsp?pack=数据包内容

　　请求参数

　　请求示例:

　　POST http://host:8080/sms/batchmt.jsp

　　请求数据

　　{

　　"cpid":"您的用户名

最后为方便大家学习测试，特意给大家准备了一份13G的超实用干货学习资源，涉及的内容非常全面。

包括，软件学习路线图，50多天的上课视频、16个突击实战项目，80余个软件测试用软件，37份测试文档，70个软件测试相关问题，40篇测试经验级文章，上千份测试真题分享，还有2021软件测试面试宝典，还有软件测试求职的各类精选简历，希望对大家有所帮助……

关注我公众号：【程序员小濠】即可获取这份资料了！

如果你不想再体验一次自学时找不到资料，没人解答问题，坚持几天便放弃的感受的话，可以加入我们的群：175317069 大家一起讨论交流，里面也有各种软件测试资料和技术交流。
 

好文推荐

5年经验之谈：月薪3000到30000，测试工程师的变“行”记！

测试工程师，自动化测试工程师，测试开发工程师，这三个岗位分别需要掌握哪些能力和技术栈？

不要让毒鸡汤毁了你，35岁的测试员没有那么可怕，保持专注更重要