[开发测试]硬核接口自动化测试 --- Rest Assured

API自动化测试方式非常多，可谓百花齐放，各种做法有各自的优势，那么今天我们简单介绍一种，通过Rest Assured 和TestNG 结合实现API自动化测试。

环境搭建

新建个maven 工程，直接在pom文件配置如下，导入Rest Assured和TestNG相应的包，可以根据实际情况导入最新版本。

        <!-- https://mvnrepository.com/artifact/io.rest-assured/rest-assured -->
        <dependency>
            <groupId>io.rest-assured</groupId>
            <artifactId>rest-assured</artifactId>
            <version>3.0.5</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.testng/testng -->
        <dependency>
            <groupId>org.testng</groupId>
            <artifactId>testng</artifactId>
            <version>6.11</version>
        </dependency>

Demo 演示

Get Demo 演示

这里我们以简书首页的推荐作者API为例，该API为Get请求，请求地址和参数：http://www.jianshu.com/users/recommended?seen_ids=&count=5&only_unfollowed=true

那么我们用Rest Assured 要模拟这个请求，
首先我们需要先导入静态方法：

import static io.restassured.RestAssured.*;

然后我们编写我们的Case：

    @Test()
    public void getHttpTest() {
        Response response = given()
                .get("http://www.jianshu.com/users/recommended?seen_ids=&count=5&only_unfollowed=true");
        // 打印出 response 的body
        response.print();
    }

https协议Demo

假设https协议，我们以豆瓣搜索图书API为例，详细API如下图所示：

?

豆瓣图书查询

那么上个case我们把参数直接跟在URL后面发起请求，下面我们把参数剥离出来，使用.params(“key”,"value","key","value"....)，同时因为是https我们需要加上ssl的配置，让所有请求支持所有的主机名：

    @Test()
    public void getHttpsTest() {
        Response response = given()
                // 配置SSL 让所有请求支持所有的主机名
                .config((RestAssured.config().sslConfig(new SSLConfig().relaxedHTTPSValidation())))
                .params("q", "自动化测试", "start", 0, "count", 2)
                .get("https://api.douban.com/v2/book/search");

        // 打印出 response 的body
        response.print();
    }

请求的参数除了可以用.params(“key”,"value","key","value"....)把所有参数都放在parames()里面，也可以用parame("key","value")形式。

    @Test()
    public void getHttpsTest2() {
        Response response = given()
                .config((RestAssured.config().sslConfig(new SSLConfig().relaxedHTTPSValidation())))
                .param("q", "自动化测试")
                .param("start", 0)
                .param("count", 2)
                .get("https://api.douban.com/v2/book/search");
        // 打印出 response 的body
        response.print();
    }

Post Demo

POST请求我们以登陆API为例，
请求方法：POST
协议：HTTP
请求地址：http://XXX.XXXX.com/Home/Login
请求参数：UserName=xxx&Password=********&CheckCode=&Remember=false&LoginCheckCode=7505
请求Content-Type类型为：application/x-www-form-urlencoded
那么实现如下：

    @Test
    public void postTest2() {

        Response response = given()
                // 设置request Content-Type
                .contentType("application/x-www-form-urlencoded")
                // 请求参数 放body
                .body("UserName=XXXX&Password=XXXXXX&CheckCode=&Remember=false&LoginCheckCode=7505")
                // POST 请求
                .post("http://XXXX.XXXX.com/Home/Login");

        response.print();
    }

当然如果请求Content-Type类型是：application/x-www-form-urlencoded，我们也可以直接用param()或者params()管理，但是如果是
application/json 则只能用body()管理参数。

    @Test
    public void postTest3(){
        Response response = given()
                .contentType("application/x-www-form-urlencoded")
                .param("CheckCode", "")
                .param("LoginCheckCode", "3719")
                .param("Password", "XXXXX")
                .param("Remember", "true")
                .param("UserName", "XXXXX")
                .post("http://XXXX.XXXXX.com/Home/Login");

        response.print();
    }

设置header，cookie

header和cookie的设置类似param，存在header()、headers()、cookie()、cookies()方法，使用也跟param类似：

        Response response = given()
                .cookie("cookie","value")
                .cookies("cookiename1", "value1", "cookiename2", "value2")
                .header("Accept-Encoding:", "gzip, deflate")
                .headers("header1","value1","header2","value2")
                .get("XXXXXXX");

获取Response 状态码：StatusCode

获取状态码，返回int类型：

response.getStatusCode();

获取Response Cookies

获取具体的某个cookies：

response.getCookie("cookiesName")

获取所有的cookies，返回一个map:

Map cookies = response1.getCookies();

Response headers 常用操作

1. 获取所有headers：

Headers headers = response.getHeaders();

1. 获取指定header：

response.getHeader("header name");
// 等同上面方法
Headers headers = response.getHeaders();
headers.get("header name");

1. 判断某个header是否存在，返回boolean类型

Headers headers = response.getHeaders();
headers.hasHeaderWithName("XXX")

1. 判断header是否为空

Headers headers = response.getHeaders();
headers.exist()

获取Response body

获取Response body，并转成String类型：

response.getBody().asString()

完整例子跟如下JSON解析一起给出。

解析JSON

Rest Assured 自带支持对JSON、xml的解析，例如我们还是以豆瓣图书查询API为例，假设我们请求参数中q= “自动化测试”，start=0，count=5那么我们模拟这个请求并做简单JSON解析：

    @Test
    public void jsonParsed() {
        Response response = given()
                .config((RestAssured.config().sslConfig(new SSLConfig().relaxedHTTPSValidation())))
                .params("q", "自动化测试", "start", 0, "count", 5)
                .get("https://api.douban.com/v2/book/search");
        // 打印出 response 的body
        response.print();

        int statusCode = response.getStatusCode();
        System.out.println("statusCode:" + statusCode);

        // 获取Response 的所有 headers 并输出
        Headers headers = response.getHeaders();
        System.out.println(headers.toString());

        // 获取Response中header名为Content-Type的值
        String contentType = response.getHeader("Content-Type");
        System.out.println("contentType:" + contentType);
        // 等同上面方法
        System.out.println(headers.get("Content-Type"));

        // 校验某个Header 是否存在
        System.out.println(headers.hasHeaderWithName("fasdfaf"));
        System.out.println(headers.hasHeaderWithName("Server"));

        // 如果Response 的headers不为空则返回true
        System.out.println(headers.exist());

        Map<String, String> cookiesMap = response.cookies();
        for (String key : cookiesMap.keySet()) {
            System.out.println(key + ":" + cookiesMap.get(key));
        }

        System.out.println(response.cookie("bid"));


        // 把Response 的body转成string类型
        System.out.println(response.getBody().asString());

        int count = response.jsonPath().getInt("count");
        System.out.println("count:" + count);

        // 获取所有的 subtitle
        ArrayList<String> subtitles = response.jsonPath().get("books.subtitle");
        for (int i = 0; i < subtitles.size(); i++) {
            System.out.println(subtitles.get(i));
        }

        // 获取特定某个的subtitle
        String subtitle = response.jsonPath().get("books.subtitle[0]");
        System.out.println(subtitle);

        // 获取倒数第二个的subtitle
        String subtitle1 = response.jsonPath().get("books.subtitle[-2]");
        System.out.println(subtitle1);

        // 获取特定tags底下的所有title
        ArrayList<String> tagTitle = response.jsonPath().get("books.tags[2].title");
        for (int i = 0; i < tagTitle.size(); i++) {
            System.out.println(tagTitle.get(i));
        }

        // 获取所有的 title
        ArrayList<ArrayList<String>> tagTitles = response.jsonPath().get("books.tags.title");
        for (int i = 0; i < tagTitles.size(); i++) {
            for (int j = 0; j < tagTitles.get(i).size(); j++) {
                System.out.println(tagTitles.get(i).get(j));
            }
            System.out.println("---------------------");

        }

        // 获取Response json里面所有title = "Selenium 2自动化测试实战"的title
        String title = response.jsonPath().get("books.title.findAll{title ->title==\"Selenium 2自动化测试实战\"}").toString();
        System.out.println(title);

        // 获取Response json中 1< numRaters <=20的所有 numRaters
        String numRaters = response.jsonPath().get("books.rating.numRaters.findAll{numRaters -> numRaters>1 && numRaters<=20}").toString();
        System.out.println(numRaters);

        // 获取Response json种title = "基于Selenium 2的自动化测试"对应的 author
        String title2 = response.jsonPath().get("books.findAll{it.title==\"基于Selenium 2的自动化测试\"}.author").toString();
        System.out.println(title2);

    }

校验Response 是否达到预期

Rest Assured提供了类似hasITems ，is，equalTo等静态方法供使用，使用时先导入方法：

import static org.hamcrest.CoreMatchers.hasItems;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.core.IsEqual.equalTo;

    @Test
    public void testDemo1() {
        Response response = given()
                .config((RestAssured.config().sslConfig(new SSLConfig().relaxedHTTPSValidation())))
                .params("q", "自动化测试", "start", 0, "count", 5)
                .expect()
                // 判断 title是否包含了 自动化 和 自动化测试
                .body("books.tags[2].title", hasItems("自动化", "自动化测试"))
                // 判断 count 值是否为 5
                .body("count", is(5))
                // 判断 publisher 值是否为 "电子工业出版社"
                .body("books.publisher[0]", is("电子工业出版社"))
                // 判断 title 是否等于 5
                .body("count", equalTo(5))
                .when()
                .get("https://api.douban.com/v2/book/search");
        // 打印出 response 的body
        response.print();
    }

尽管Rest Assured 提供了校验方法，但是在实际API自动化测试过程中，因为往往需要校验的字段非常多，建议还是直接先把要校验的JSON字段解析出来，再通过TestNG提供的Assert类进行校验。

补充个例子

Web API 里面非常多的API发起请求都需要在用户登陆下才能发起，而判断用户是否登录往往就是去判断cookies，所以如果遇到这类问题，只需要在需要模拟的API中设置cookies为登录API生成的cookies便可。
例如下demo，第二个请求通过的前提是拿到第一个请求的cookies，那么我们就把第一个请求的response中的所有cookies放到第二个请求作为request:

    @Test
    public void postHttpsTest3() {
        Response response1 = given()
                .contentType("application/x-www-form-urlencoded")
                .body("UserName=XXXX&Password=XXXXX&CheckCode=&Remember=false&LoginCheckCode=7505")
                .post("http://XXXX.XXXX.com/Home/Login");

        response1.print();
        // 获取reponse中所有的cookies
        Map cookies = response1.getCookies();

        Response response2 = given()
                // 写入第一个请求的cookies
                .cookies(cookies)
                .contentType("application/x-www-form-urlencoded")
                .param("ActionName", "")
                .param("CurrentUserNo", "XXXXX")
                .post("http://XXXX.XXXXX.com/Home/IsCurrentAccountValid");

        response2.print();
    }

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

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

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

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

?