怎么调用json接口测试

怎么调用JSON接口测试

在当今的软件开发中，JSON（JavaScript Object Notation）已成为接口数据交换的主流格式，无论是前后端数据交互、第三方服务集成，还是微服务架构通信，接口测试都是保障系统稳定性的关键环节，而调用JSON接口测试，则是接口测试中的核心操作，本文将从“准备-调用-验证-自动化”四个步骤，结合工具和代码示例,带你全面JSON接口测试的方法。

测试前的准备工作：明确目标与环境

在调用JSON接口之前，充分的准备能让测试更高效、更有针对性,主要准备工作包括：

明确接口文档与测试目标

接口文档是测试的“说明书”，通常包含以下关键信息：

接口地址（URL）：包括测试环境、预发布环境、生产环境的完整路径（如https://api.example.com/users）。
请求方法（Method）：GET（查询）、POST（新增）、PUT（修改）、DELETE（删除）等。
请求参数（Parameters）：
- 路径参数（Path Params）：URL中的变量（如/users/{id}中的id）；
- 查询参数（Query Params）：URL中的键值对（如?page=1&size=10）；
- 请求体（Body）：POST/PUT请求通常需要携带JSON格式的数据（如用户信息、订单数据等）。
请求头（Headers）：如Content-Type: application/json（声明请求体为JSON）、Authorization: Bearer xxx（身份认证令牌）等。
响应格式（Response）：JSON格式的返回数据结构（如成功返回{"code": 200, "data": {...}, "msg": "success"}，失败返回{"code": 400, "msg": "参数错误"}）。

测试目标需明确：是测试接口的功能逻辑（如参数校验、业务规则）、性能（响应时间、并发能力），还是安全性（权限校验、数据加密）？

搭建测试环境

确保测试环境与生产环境隔离，避免影响线上服务，测试环境需满足：

接口服务已部署并正常运行；
测试数据已准备（如测试用户、测试订单等，避免脏数据污染生产环境）；
网络连通（本地能访问测试环境的API地址）。

调用JSON接口的常用方法与工具

调用JSON接口的核心是发送HTTP请求并接收JSON响应，根据场景不同,可选择手动工具或代码脚本实现。

手动工具：快速验证接口功能

手动工具适合接口初测、临时调试，无需编写代码，操作直观，常用工具包括：

（1）Postman：接口测试“神器”

Postman是业界最流行的API测试工具，支持HTTP/HTTPS请求、参数配置、响应断言等。

操作步骤：

新建请求：打开Postman，点击“New” → “HTTP Request”，填写请求URL、选择请求方法（GET/POST等）。
配置请求头：在“Headers”标签页添加Content-Type: application/json（若请求体为JSON），以及认证头（如Authorization: Bearer your_token）。
配置请求参数：
- GET请求：在“Params”标签页添加查询参数（Key为参数名，Value为参数值）；
- POST/PUT请求：在“Body”标签页选择“raw” → “JSON”，输入JSON格式的请求体（如{"name": "张三", "age": 25}）。
发送请求：点击“Send”按钮，在下方“Body”标签页查看响应结果（自动解析JSON格式）。

示例：测试用户登录接口（POST https://api.example.com/login）

请求头：Content-Type: application/json
请求体：{"username": "test_user", "password": "123456"}
响应：{"code": 200, "data": {"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}, "msg": "登录成功"}

（2）curl：命令行工具，适合开发者调试

curl是Linux/macOS自带的命令行HTTP工具，也可在Windows的CMD或PowerShell中使用，通过命令行发送HTTP请求，灵活高效。

基本语法：

curl -X 请求方法 -H "请求头" -d "请求体" "接口地址"

示例：调用上述登录接口

curl -X POST -H "Content-Type: application/json" -d '{"username": "test_user", "password": "123456"}' "https://api.example.com/login"

响应：命令行会直接输出JSON格式的返回数据，若需格式化，可通过管道结合jq工具（Linux/macOS JSON处理器）：

curl -X POST -H "Content-Type: application/json" -d '{"username": "test_user", "password": "123456"}' "https://api.example.com/login" | jq .

代码脚本：自动化测试与集成

手动工具适合临时测试，但无法实现大规模、重复性的测试，代码脚本（如Python、Java）结合测试框架，可实现接口自动化测试。

（1）Python：requests库 + pytest框架

Python的requests库是发送HTTP请求的利器，简单易用；pytest是流行的测试框架，支持用例管理、断言、参数化等。

步骤：

安装依赖：pip install requests pytest
编写测试脚本（如test_api.py）：

import requests
import pytest
def test_user_login():
    # 接口地址
    url = "https://api.example.com/login"
    # 请求头
    headers = {"Content-Type": "application/json"}
    # 请求体
    payload = {"username": "test_user", "password": "123456"}
    # 发送POST请求
    response = requests.post(url, json=payload, headers=headers)
    # 断言：响应状态码为200
    assert response.status_code == 200
    # 断言：响应体包含token
    response_data = response.json()
    assert "token" in response_data["data"]
    assert response_data["code"] == 200
if __name__ == "__main__":
    pytest.main(["-v", "test_api.py"])

说明：

requests.post(url, json=payload)会自动将payload序列化为JSON，并设置Content-Type: application/json；
response.json()将响应体解析为Python字典，方便断言；
pytest支持运行单个用例（pytest test_api.py::test_user_login）或批量运行。

（2）Java：OkHttp + JUnit5

Java项目中，常用OkHttp发送HTTP请求，JUnit5做测试框架。

步骤：

添加依赖（Maven）：

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.10.0</version>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-api</artifactId>
    <version>5.8.2</version>
    <scope>test</scope>
</dependency>

编写测试类（如ApiTest.java）：

import okhttp3.*;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;
import java.io.IOException;
public class ApiTest {
    @Test
    public void testUserLogin() throws IOException {
        // 接口地址
        String url = "https://api.example.com/login";
        // 请求体
        MediaType JSON = MediaType.get("application/json; charset=utf-8");
        String jsonBody = "{\"username\": \"test_user\", \"password\": \"123456\"}";
        RequestBody body = RequestBody.create(jsonBody, JSON);
        // 构建请求
        Request request = new Request.Builder()
                .url(url)
                .post(body)
                .header("Content-Type", "application/json")
                .build();
        // 发送请求
        OkHttpClient client = new OkHttpClient();
        try (Response response = client.newCall(request).execute()) {
            // 断言：响应状态码为200
            assertEquals(200, response.code());
            // 断言：响应体包含token
            String responseBody = response.body().string();
            assertTrue(responseBody.contains("\"token\""));
            System.out.println("Response: " + responseBody);
        }
    }
}

说明：