接口测试之什么是接口文档？

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

        没有接口文档的接口测试都是在抓瞎~前面的接口测试重点讲了协议，也讲了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':'您的用户名',
    'cppwd':'您的密码',
    'items':[
        {
            'content':'111【软件测试部落】',
            'phone':'123123212312',
            'extend':'123123',
            'spnumber':'11111'
        },
        {
            'content':'222【软件测试部落】',
            'phone':'12312312312',
            'extend':'123123',
            'spnumber':'11111'
        }
    ]
}

五、接口标准文档

六、测试方法

输入参数测试：针对输入的参数进行测试，也可以说是假定接口参数数的不正确性进行的测试，确保接口对任意类型的输入都做了相应的处理：
输入参数合法，
输入参数不合法，
输入参数为空，
输入参数为null
输入参数超长

（主要参照接口测试文档）

功能测试

（主要参照需求文档）

异常测试

（模拟各种可能发生的异常场景）

接口测试方法在第一篇已经讲过，这里就不多说了，建议参考下面视频。

7天练完接口自动化测试30个实战项目，28K入职字节测试岗。【自动化测试/接口测试/软件测试/性能测试/Jmeter】

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！