带你做接口测试从零到第一条用例 总结

Posted 软件测试自动化测试

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了带你做接口测试从零到第一条用例 总结相关的知识,希望对你有一定的参考价值。

目录

序章

请求模型

请求结构

接口的请求会发向哪里

复杂一点的接口,RESTful

5. 接口测试

接口测试用例


序章

​ 说起接口测试,网上有很多例子,但是当初做为新手的我来说,看了不不知道他们说的什么,觉得接口测试,好高大上。认为学会了接口测试就能屌丝逆袭,走上人生巅峰,迎娶白富美。因此学了点开发知识后,发现接口测试其实都是人们玩的名词罢了。接口测试,真心很简单。它只不过是数据传递是一种表现而已。

请求模型

​ 看下图中“A”线,可以理解为接口就是一个电灯的开关,它在接口里面给你提供了一个参数,参数的值一个是“开”,一个是“关”。

​ 说起来,怎么才能让灯亮?一个灯头接两根线,一根线接火线,一根线接零线这时灯就亮了。反之,不接零线、火线灯就灭了。

​ 其实接口呢,就把这些复杂的操作简化了,让你看到的就只有一个开关,而你来操作这个开关就好了。我们做接口测试也只需要测试这个开关就完成任务了,接口测试就是这么简单。

  1. 当你访问“http://127.0.0.1:8080/light?opt=open”,让零线、火线连通,此时灯亮。
  2. 当你访问“http://127.0.0.1:8080/light?opt=close”,让零线、火线断开,此时灯灭。

请求结构

​ 看到这里我们大致就明白了接口测试是怎么一回事了。接下来需要理解一下HTTP的URL是怎么组成为一个接口的。如图:

  1. 一个URL就是一个接口:接口大致会分为一下几个部分:

    1. 请求协议:

      • http — 普通的http请求
      • https — 加密的http请求,传输数据更加安全
      • ftp — 文件传输协议,主要用来传输文件
    2. 请求IP:就是指提供接口的系统所部署的服务器地址

    3. 请求端口:如果不填端口,默认是80,否则需要填写端口号

    4. 接口路径:指系统提供的接口在什么位置

    5. 接口参数:参数在接口路径后,用“?”来表示路径地址完了,剩下的都是参数了,用“&”来区分参数个数,

      如下示例:

      http://127.0.0.1:8080/light?opt=open&use=yy&pwd=123456

      假设要操作这个灯,需要用户密码,则可以增加新的参数”use”、”pwd”,用”&”来隔开。可以看到这个示例有3个参数:

      • “opt”:”open”
      • “use”:”yy”
      • “pwd”:”123456”
    6. 接口HTTP参数【url看不见等隐藏参数】

      • http请求方式

        GET --- 通过请求URI得到资源
        POST --- 用于添加新的内容
        PUT --- 用于修改某个内容
        DELETE --- 删除某个内容
        CONNECT --- 用于代理进行传输,如使用SSL
        OPTIONS --- 询问可以执行哪些方法
        PATCH --- 部分文档更改
        PROPFIND (wedav) --- 查看属性
        PROPPATCH (wedav) --- 设置属性
        MKCOL (wedav) --- 创建集合(文件夹)
        COPY (wedav) --- 拷贝
        MOVE (wedav) --- 移动
        LOCK (wedav) --- 加锁
        UNLOCK (wedav) --- 解锁
        TRACE --- 用于远程诊断服务器
        HEAD --- 类似于GET, 但是不返回body信息,用于检查对象是否存在,以及得到对象的元数据
        
      • http请求头

        请求头包含许多有关的客户端环境和请求正文的有用信息。例如,请求头可以声明浏览器所用的语言,请求正文的长度。示例:

        Accept:image/gif.image/jpeg./
        Accept-Language:zh-cn
        Connection:Keep-Alive
        Host:localhost
        User-Agent:Mozila/4.0(compatible:MSIE5.01:Windows NT5.0)
        Accept-Encoding:gzip,deflate.
        
      • http请求体

        请求体就是请求等正文了,可以有很多种请求体。

        • json格式
        • xml格式
        • html格式
        • 二进制格式( 多数用于图片 )
        • 字符串格式

​ 看到上面的请求结构,就能接口测试了,只需要修改接口的参数,就可以像功能测试一样测了。可以用功能测试设计用例的方法来设计接口测试的用例。可以使用各种测试用具辅助测试,下图为“postman”测试工具。

接口的请求会发向哪里

我们可以看看这样一个接口,用Java的Servlet怎么来实现

package com.yy.test;

import net.sf.json.JSONObject;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

// 接口的名称与路径,urlPatterns中的/light,就是说在输入地址与ip后,定义的接口名字http://127.0.0.1:8080/light 
@WebServlet(name = "light", urlPatterns = "/light")
public class light extends HttpServlet 
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException 
        // 获取opt的值 
        String opt = request.getParameter("opt");

        // 新建返回json的对象 
        JSONObject json = new JSONObject();

        // 判断opt有没有值 
        if (null != opt) 

            // 定义返回的请求头,类型是json,编码是utf-8 
            response.setContentType("application/json; charset=UTF-8");

            // 定义返回的对象,用它来将json输出 
            PrintWriter out = response.getWriter();

            // 判断opt的值是不是open 
            if ("open".equals(opt)) 
                json.put("msg", "开灯啦!");
                out.println(json);
            

            // 判断opt的值是不是close 
            else if ("close".equals(opt)) 
                json.put("msg", "关灯啦!");
                out.println(json);
            
        
    

上面的代码大致做了如下几个操作:

  1. 获取opt的值
  2. 判断获取的opt的值

    • 如果是”open”就返回”开灯啦!”
    • 如果是”close”就返回”关灯啦!”

      看到上面的代码,就能发现,我们将opt的值,传进”http://127.0.0.1:8080/light“这个接口中,当你拿到你想要的值,想做什么都可以了,对吧。我这边的代码就是简单的进行了返回,当你访问了我“开灯”的接口,我就直接告诉你“开灯了” ( 其实我什么都没做,这已经算是一个BUG了。所以测试接口要看看它到底生效了没有,也就是说,灯真的开了吗?),我们做接口测试,需要开发提供接口文档。最重要的有一下几点:

  3. 被测接口的地址

  4. 接口参数,以及各个参数的说明
  5. 必要的http头与http体 ( http头是可以自定义的,可以用来校验是否是自己人访问 )
  6. 接口返回什么值,以及各个返回值的说明
  7. 接口是干什么的

确定了这些,才能做好接口测试。好的接口文档如下:

复杂一点的接口,RESTful

一个用户接口可以通过以下4种不同方式的请求,来做不同的事情:

  1. 获取用户信息
  2. 创建用户
  3. 修改用户
  4. 删除用户

你完全可以像“灯”的那个例子,用GET请求来传递不同的参数来实现,但是这样如果接口多了,就会很混乱,很难管理。

这时,我们需要一种规则:

  1. 当用“GET”方式时,只用来获取数据,成功了返回http状态码200
  2. 当用“POST”方式时,只用来创建数据,成功了返回http状态码201
  3. 当用“PUT”方式时,只用来修改数据,成功了返回http状态码203
  4. 当用“DELETE”方式时,只用来删除数据,成功了返回http状态码204
  5. 当请求发送失败,返回http状态码400

这样子的规则,我们称它为“RESTful”标准。

下图是RESTful的状态码返回

5. 接口测试

前面的搞清楚了,接口测试就简单了,其实就是几个步骤。

  1. 拿到接口的url地址
  2. 查看接口是用什么方式发送
  3. 添加请求头,请求体
  4. 发送查看返回结果,校验返回结果是否正确

这个是正常的一套流程,异常的情况,就不用我多说来吧。比如参数不传值呀,传的值不正确呀,明明要求用"GET"请求发送,偏要用"POST"请求发送呀。等等有很多异常情况,一般懂功能测试都能想到很多的异常情况,这里不再举例来。

下面我以百度翻译的接口为例子:

请求地址:http://fanyi.baidu.com/v2transapi

请求方式:POST

请求参数:

​ from — 哪国语言

    to --- 翻译成哪国语言

    query --- 翻译都内容

​ 我使用Python语言来进行接口测试,使用”requests”库来编写代码比较简答易懂,如果没有安装”requests”库,可以打开cmd,输入”pip install requests”来安装

import requests

# 接口的url 
url = "http://fanyi.baidu.com/v2transapi"

# 接口的参数 
params =  
    "from":"en", 
    "to":"zh", 
    "query": "test"


# 发送接口 
r = requests.request("post", url, params=params)

# 打印返回结果 
print(r.text)

# 其实到上面就已经完了,因为百度不是我自己写的接口,为了让结果看的更加清楚一点,我取来翻译的字段 
import json
d = json.loads(r.text)
print(d['liju_result']['tag'])
返回结果

['试验', '测验', '考验', '化验', '考查', '受试验', '受测验', '受考验', '测得结果']


可以试着将"query"的参数改成"student",返回结果也随之改变

import requests

url = "http://fanyi.baidu.com/v2transapi"
params =  
    "from":"en", 
    "to":"zh", 
    "query": "student" # 我改了这里 


r = requests.request("post", url, params=params)

import json
d = json.loads(r.text)
print(d['liju_result']['tag'])
返回结果

['中学生', '学生', '大学生', '研究者', '学者']

​ 当然,要是不懂代码,也可以使用工具进行测试,只要记住填写的几个点,就可以做好接口测试,下图是使用”postman”进行测试:

  1. 输入发送方式”POST”
  2. 输入测试地址”http://fanyi.baidu.com/v2transapi
  3. 输入下图红框参数
  4. 点击”send”,查看返回结果

 接口测试就是这么简单

接口测试用例

接口测试用例的设计就没什么好讲的了,与功能测试一样设计就好了。我是用Excel来编写的,主要是为了方便管理,只要写的干净,让人看的很舒服就好了。我自己设计的用例是这样的:

  1. 一个模块对应一个Excel表
  2. 一条接口对应一张sheet表
  3. 表中一行对应一条测试用例
  4. 在开始要注明测试时需要的sql,如下图开始我会创建用户,用完了我会删除

这样的用例比较好管理,如图:

整个接口测试就这么多了。接口测试其实很简单,在功能测试眼里,接口测试那么高大上,其实不也过如此了。

 感谢每一个认真阅读我文章的人,看着粉丝一路的上涨和关注,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接免费拿走:

① 2000多本软件测试电子书(主流和经典的书籍应该都有了)

② 软件测试/自动化测试标准库资料(最全中文版)

③ 项目源码(四五十个有趣且经典的练手项目及源码)

④ Python编程语言、API接口自动化测试、web自动化测试、App自动化测试(适合小白学习)


⑤ Python学习路线图(告别不入流的学习)

上图的资料 在我的QQ技术交流群里(技术交流和资源共享,广告进来腿给你打断)

可以自助拿走,群号953306497(备注“csdn111”)群里的免费资料都是笔者十多年测试生涯的精华。还有同行大神一起交流技术哦。

以上是关于带你做接口测试从零到第一条用例 总结的主要内容,如果未能解决你的问题,请参考以下文章

登录后才能操作的接口第一条用例设计成登录再使用session保持会话

第二条用例需要用到第一条用例返回结果中的某些值

十年测试大佬教你如何从零到一落地接口自动化测试?

robotframework我写了一条用例如何让这条用例循环跑100次

黑盒测试用例设计方法总结

使用“数据驱动测试”之前你应该知道的