jck28-lucio-接口请求体-json

学习笔记
1

目录

  • 接口请求体介绍
  • json 类型请求体介绍
  • json 类型请求体构造

课程目标

  1. 掌握接口请求体概念，以及多种请求体的区别。
  2. 掌握什么是 json 类型的请求体。
  3. 掌握如何 json 类型请求体构造。

思考

在接口自动化测试中，如果要根据右图的接口文档上传请求体，应该如何配置？

image
image1772×1502 167 KB

什么是请求体信息

  • 进行 HTTP 请求时，发送给服务器的数据。
  • 数据格式类型可以是 JSON、XML、文本、图像等格式。
  • 请求体的格式和内容取决于服务器端 API 的设计和开发人员的要求。
    image
    image886×514 32.8 KB

常用接口请求体应用场景

类型 介绍 Content-type
JSON（JavaScript Object Notation） 轻量级的数据交换格式，最常见的一种类型。 application/json
表单数据（Form Data） 以键值对的形式提交数据，例如通过 HTML 表单提交数据。 application/x-www-form-urlencoded
XML（eXtensible Markup Language） 常用的标记语言，通常用于传递配置文件等数据。 application/xml
text/xml
文件（File） 可以通过请求体上传文件数据，例如上传图片、视频等文件。 上传文件的 MIME 类型，例如 image/jpeg
multipart/form-data
纯文本（Text） 纯文本数据，例如发送邮件、发送短信等场景 text/plain
其他格式 二进制数据、protobuf 等格式
![image 800x361](upload://f1ZR66Vr8ORgr6zGMNGfeXOecY8.jpeg)

JSON 简介

  • 是 JavaScript Object Notation 的缩写。
  • 是一种轻量级的数据交换格式。
  • 是理想的接口数据交换语言。
  • Content-Type 为 application/json。
    image
    image2684×1274 296 KB

JSON 格式请求体示例

  1. 进入登录页面。
  2. 打开开发者工具。
  3. 输入用户名密码，点击登录。

https://litemall.hogwarts.ceshiren.com/#/login

JSON 类型接口请求体构造（Java）

  • 通过given().body(jsonData)添加请求体信息：
    • JSON 对象 。
    • 直接复制 String 。
package com.ceshiren.body.json;


import net.minidev.json.JSONObject;
import org.junit.jupiter.api.Test;
import static io.restassured.RestAssured.given;

public class TestJson {

    @Test
    void objectPostJson(){
        JSONObject requestBody = new JSONObject();
        requestBody.put("key1", "value1");
        requestBody.put("key2", "value2");
        given()
            .body(requestBody.toString()).log().all()
        .when()
            .post("https://httpbin.ceshiren.com/post")
        // 打印全部的相应信息
            .then().log().all();
        }
    @Test
    void stringPostJson(){
        String jsonData = "{\"username\":\"hogwarts\",\"password\":\"test12345\",\"code\":\"\"}";
        given()
                .body(jsonData).log().all()
                .when()
                .post("https://litemall.hogwarts.ceshiren.com/admin/auth/login")
                // 打印全部的相应信息
                .then().log().all();

    }
    }

源码地址（Java）

gitlab.stuq.ceshiren.com

附录：完整依赖配置（Java）

<!-- 其他使用到的依赖配置  -->
<!--   版本配置-->
<properties>
    <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
    <java.version>11</java.version>
    <junit.jupiter.version>5.9.2</junit.jupiter.version>
    <maven.compiler.version>3.11.0</maven.compiler.version>
    <maven-surefire-plugin.version>3.0.0</maven-surefire-plugin.version>
    <rest-assured.version>5.3.0</rest-assured.version>
    <json-path.version>2.8.0</json-path.version>
    <!-- allure报告 -->
    <allure.version>2.21.0</allure.version>
    <aspectj.version>1.9.19</aspectj.version>
    <allure.maven.version>2.12.0</allure.maven.version>
    <allure.cmd.download.url>
        https://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline
    </allure.cmd.download.url>
</properties>
<dependencyManagement>
    <!--        junit5 版本管理， 找到对应依赖关系的 pom 文件，为了解决依赖冲突问题-->
    <dependencies>
        <dependency>
            <groupId>org.junit</groupId>
            <artifactId>junit-bom</artifactId>
            <version>${junit.jupiter.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>

    <!--        junit 相关依赖下载-->
    <!-- junit5 -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- junit5-suite -->
    <dependency>
        <groupId>org.junit.platform</groupId>
        <artifactId>junit-platform-suite</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- 用做兼容老版本 -->
    <dependency>
        <groupId>org.junit.vintage</groupId>
        <artifactId>junit-vintage-engine</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- rest-assured -->
    <dependency>
        <groupId>io.rest-assured</groupId>
        <artifactId>rest-assured</artifactId>
        <version>${rest-assured.version}</version>
        <scope>compile</scope>
    </dependency>
    <!-- json path 解析json文件 -->
    <dependency>
        <groupId>com.jayway.jsonpath</groupId>
        <artifactId>json-path</artifactId>
        <version>${json-path.version}</version>
    </dependency>
    <!--        allure报告-->
    <dependency>
        <groupId>io.qameta.allure</groupId>
        <artifactId>allure-junit5</artifactId>
        <version>${allure.version}</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>${aspectj.version}</version>
    </dependency>

</dependencies>
<build>
    <plugins>
        <!--            maven 命令行执行插件-->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>${maven-surefire-plugin.version}</version>
            <configuration>
                <argLine>
                    -javaagent:"${settings.localRepository}/org/aspectj/aspectjweaver/${aspectj.version}/aspectjweaver-${aspectj.version}.jar"
                </argLine>
            </configuration>
            <!--                防止maven与junit5使用依赖冲突的问题-->
            <dependencies>
                <dependency>
                    <groupId>org.junit.jupiter</groupId>
                    <artifactId>junit-jupiter-engine</artifactId>
                    <version>${junit.jupiter.version}</version>
                </dependency>
                <dependency>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                    <version>${junit.jupiter.version}</version>
                </dependency>
            </dependencies>
        </plugin>
        <!--            maven 编译使用插件-->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>${maven.compiler.version}</version>
            <configuration>
                <parameters>true</parameters>
                <source>${java.version}</source>
                <target>${java.version}</target>
                <encoding>${maven.compiler.encoding}</encoding>
            </configuration>
        </plugin>

        <plugin>
            <groupId>io.qameta.allure</groupId>
            <artifactId>allure-maven</artifactId>
            <version>${allure.maven.version}</version>
            <configuration>
                <reportVersion>${allure.version}</reportVersion>
                <allureDownloadUrl>${allure.cmd.download.url}/${allure.version}/allure-commandline-${allure.version}.zip</allureDownloadUrl>
            </configuration>
        </plugin>
    </plugins>
</build>