正文

手把手教你用Swagger打造高效API自动化测试脚本

/0 浏览量
0628

引言

在软件开发过程中，API（应用程序编程接口）的测试是确保系统稳定性和功能性的关键环节。Swagger作为一个强大的API文档和测试平台，可以帮助开发者快速生成API文档，并提供API测试功能。本文将手把手教你如何使用Swagger打造高效的API自动化测试脚本。

一、了解Swagger

Swagger是一个用于构建、测试和文档化RESTful API的强大工具。它可以帮助你：

  • 自动生成API文档
  • 提供API交互界面
  • 支持自动化测试

二、安装Swagger

首先，你需要安装Swagger。以下是几种常见的安装方式：

2.1 在线安装

  1. 访问Swagger官网：https://swagger.io/
  2. 下载适合你平台的Swagger代码
  3. 解压并运行start脚本

2.2 使用Maven

在你的项目pom.xml文件中添加以下依赖：

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.5.22</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
    <version>1.5.22</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-core</artifactId>
    <version>1.5.22</version>
</dependency>

三、创建Swagger项目

3.1 使用Swagger Codegen

  1. 访问Swagger Codegen官网：https://github.com/swagger-api/swagger-codegen
  2. 下载并安装代码生成器
  3. 运行以下命令生成项目结构：
./generate.sh -i petstore.yaml -l java

3.2 手动创建项目

  1. 创建一个Java项目
  2. 添加Swagger相关依赖
  3. 创建API接口类、控制器类等

四、编写API测试脚本

4.1 使用Swagger UI

  1. 在项目根目录下创建swagger-ui文件夹
  2. 将swagger-ui文件夹中的index.html文件替换为以下内容：
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Swagger UI</title>
    <link rel="stylesheet" type="text/css" href="swagger-ui.css">
</head>
<body>
    <div id="swagger-ui"></div>
    <script src="swagger-ui-bundle.js"></script>
    <script src="swagger-ui-standalone-preset.js"></script>
    <script>
        window.onload = function() {
            var url = '/v2/api-docs'; // 替换为你的API文档地址
            var doc = new SwaggerUI({
                url: url,
                domId: '#swagger-ui',
                docExpansion: 'list',
                layout: 'StandaloneLayout',
                showRequestHeaders: true
            });
        };
    </script>
</body>
</html>
  1. 运行swagger-ui文件夹中的start脚本

4.2 使用JUnit测试

  1. 在项目中创建一个新的测试类
  2. 使用Mockito、RestAssured等库模拟API调用
  3. 编写测试用例

以下是一个简单的JUnit测试示例：

import static org.mockito.Mockito.when;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.spy;
import static org.mockito.MockitoAnnotations.openMocks;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;

import com.fasterxml.jackson.databind.ObjectMapper;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;

@ExtendWith(MockitoExtension.class)
@SpringBootTest
@AutoConfigureMockMvc
public class MyControllerTest {

    @Mock
    private MyService myService;

    @InjectMocks
    private MyController myController;

    @Mock
    private MockMvc mockMvc;

    @Mock
    private ObjectMapper objectMapper;

    @BeforeEach
    public void setUp() throws Exception {
        openMocks(this);
    }

    @Test
    public void testGetMyData() throws Exception {
        MyData myData = new MyData();
        myData.setName("张三");
        myData.setAge(20);

        when(myService.getMyData()).thenReturn(myData);

        mockMvc.perform(get("/my-data").contentType(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.name").value("张三"))
                .andExpect(jsonPath("$.age").value(20));
    }
}

五、总结

通过以上步骤，你已成功使用Swagger打造了一个高效的API自动化测试脚本。在实际开发过程中，你可以根据需求不断优化和扩展你的测试脚本。希望本文对你有所帮助！

-- 展开阅读全文 --