Add api data unit tests. Perform api request codes.

Author: Json031

README.md

@@ -60,7 +60,7 @@ mcunittests是SpringBoot项目的一个单元测试库，支持API接口自动
 
 ## 示例代码 Example Codes
 ```
-import io.github.json031.MCApiTests;
+import io.github.json031.apitests.MCApiTests;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;
 

pom.xml

@@ -5,7 +5,7 @@
   <groupId>io.github.json031</groupId>
   <artifactId>mcunittests</artifactId>
   <packaging>jar</packaging>
-  <version>1.0.7</version>
+  <version>1.0.8</version>
   <name>mcunittests</name>
   <description>mcunittests是SpringBoot项目的一个单元测试库，是一个在MIT许可下分发的开源项目</description>
   <url>https://github.com/Json031/mcunittests</url>
@@ -40,6 +40,11 @@
       <version>5.13.0-M2</version>
       <scope>compile</scope>
     </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+      <version>2.15.0</version>
+    </dependency>
   </dependencies>
 
   <licenses>
@@ -58,7 +63,6 @@
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
   </properties>
 
-  <!-- 只保留 GitHub Packages 配置 -->
   <distributionManagement>
     <repository>
       <id>github</id>

src/main/java/io/github/json031/JavaBean/HighConcurrencyResult.java

@@ -1,9 +1,24 @@
 package io.github.json031.JavaBean;
 
+/**
+ * High Concurrency Result.
+ */
 public class HighConcurrencyResult {
+    /**
+     * total request times.
+     */
     public final int total;
+    /**
+     * request success times.
+     */
     public final int success;
+    /**
+     * request failed times.
+     */
     public final int failed;
+    /**
+     * request average cost timeMillis.
+     */
     public final long avgResponseTimeMillis;
 
     public HighConcurrencyResult(int total, int success, int failed, long avgResponseTimeMillis) {

src/main/java/io/github/json031/JavaBean/RequestUnitTestsResult.java

@@ -0,0 +1,18 @@
+package io.github.json031.JavaBean;
+
+import org.springframework.http.ResponseEntity;
+
+/**
+ * Request Unit Tests Result.
+ */
+public class RequestUnitTestsResult {
+    // 毫秒级耗时
+    public final long durationMillis;
+    // api请求响应结果
+    public final ResponseEntity<String> response;
+
+    public RequestUnitTestsResult(long durationMillis, ResponseEntity<String> response) {
+        this.durationMillis = durationMillis;
+        this.response = response;
+    }
+}

src/main/java/io/github/json031/MCApiTests.java renamed to src/main/java/io/github/json031/apitests/MCApiTests.java

@@ -1,16 +1,18 @@
-package io.github.json031;
+package io.github.json031.apitests;
 
+import io.github.json031.JavaBean.RequestUnitTestsResult;
+import io.github.json031.unittests.DataUnitTests;
+import io.github.json031.unittests.RequestUnitTests;
 import org.junit.jupiter.api.Assertions;
 import org.springframework.http.*;
-import org.springframework.web.client.RestTemplate;
 
-import java.time.Duration;
 import java.util.Map;
 
+/**
+ * This class is used for unit testing api.
+ */
 public class MCApiTests {
 
-    private final RestTemplate restTemplate = new RestTemplate();
-
     /**
      * 通用测试方法，验证给定 API 是否能在 timeout 秒内响应
      *
@@ -48,54 +50,31 @@ public long assertApiRespondsWithinTimeoutMillis(String url,
                                                      Map<String, String> headers,
                                                      long timeoutMillis,
                                                      boolean verbose) {
-        try {
-            HttpHeaders httpHeaders = new HttpHeaders();
-            if (headers != null) {
-                headers.forEach(httpHeaders::set);
-            }
-
-            HttpEntity<?> entity;
-            String finalUrl = url;
-
-            if (method == HttpMethod.GET && params != null && !params.isEmpty()) {
-                // 拼接 GET 参数
-                StringBuilder queryBuilder = new StringBuilder(url);
-                queryBuilder.append(url.contains("?") ? "&" : "?");
-                params.forEach((key, value) -> queryBuilder.append(key).append("=").append(value).append("&"));
-                finalUrl = queryBuilder.substring(0, queryBuilder.length() - 1); // 去掉最后一个 &
-                entity = new HttpEntity<>(httpHeaders);
-            } else {
-                // POST 请求体（可为 null）
-                entity = new HttpEntity<>(params, httpHeaders);
-            }
-
-            long start = System.nanoTime();
-
-            ResponseEntity<String> response = restTemplate.exchange(
-                    finalUrl,
-                    method,
-                    entity,
-                    String.class
-            );
-
-            long end = System.nanoTime();
-            long durationMillis = (end - start) / 1_000_000;
-
-            if (verbose) {
-                System.out.println("API Response: " + response.getBody());
-                System.out.println("Response time: " + durationMillis + " ms");
-            }
-
-            if (durationMillis > timeoutMillis) {
-                Assertions.fail("API did not respond within " + timeoutMillis + " ms, url: " + finalUrl);
-            }
-
-            return durationMillis;
+        RequestUnitTestsResult result = RequestUnitTests.requestWitRestTemplate(url, method, params, headers, verbose);
+        return DataUnitTests.withinTimeOut(result, timeoutMillis);
+    }
 
-        } catch (Exception e) {
-            Assertions.fail("API call failed for: " + url + " with error: " + e.getMessage());
+    /**
+     * 通用测试方法，验证给定 API 是否返回有效json格式数据。
+     *
+     * @param url           完整的 API 地址（包括 http/https）
+     * @param method        请求方式（GET / POST）
+     * @param params        请求参数（POST body 或 GET 查询参数）
+     * @param headers       请求头（可选）
+     * @param verbose       是否打印响应
+     */
+    public void testApiReturnsValidJson(String url,
+                                        HttpMethod method,
+                                        Map<String, Object> params,
+                                        Map<String, String> headers,
+                                        boolean verbose) {
+        RequestUnitTestsResult result = RequestUnitTests.requestWitRestTemplate(url, method, params, headers, verbose);
+        if (result == null) {
+            Assertions.fail("API did not respond valid json, url: " + url);
+        } else {
+            ResponseEntity<String> response = result.response;
+            DataUnitTests.isValidJSON(response.getBody());
         }
-
-        return -1;
     }
+
 }

src/main/java/io/github/json031/MCHighConcurrencyTests.java renamed to src/main/java/io/github/json031/apitests/MCHighConcurrencyTests.java

@@ -1,20 +1,20 @@
-package io.github.json031;
+package io.github.json031.apitests;
 
 import io.github.json031.JavaBean.HighConcurrencyResult;
 import org.junit.jupiter.api.Assertions;
 import org.springframework.http.HttpMethod;
-import org.springframework.web.client.RestTemplate;
 
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.*;
 import java.util.concurrent.atomic.AtomicInteger;
-import java.util.function.Supplier;
 
+/**
+ * This class is used for unit testing api High Concurrency.
+ */
 public class MCHighConcurrencyTests {
 
-    private final RestTemplate restTemplate = new RestTemplate();
     private final MCApiTests mcApiTests = new MCApiTests();
 
     /**

src/main/java/io/github/json031/unittests/DataUnitTests.java

@@ -0,0 +1,72 @@
+package io.github.json031.unittests;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.github.json031.JavaBean.RequestUnitTestsResult;
+import org.junit.jupiter.api.Assertions;
+
+import java.net.URL;
+
+/**
+ * This class is used for unit testing data.
+ */
+public class DataUnitTests {
+
+    /**
+     * 验证是否为有效json格式数据。
+     * @param json        数据
+     * @return 是否为有效json格式数据。
+     */
+    public static Boolean isValidJSON(String json) {
+        // 用 Jackson 尝试解析 JSON
+        ObjectMapper mapper = new ObjectMapper();
+        try {
+            mapper.readTree(json);  // 验证数据是否为合法JSON格式数据
+            return true;
+        } catch (Exception e) {
+            Assertions.fail("Invalid JSON data: " + json);
+            return false;
+        }
+    }
+
+    /**
+     * 是否超出期望响应时间
+     * @param result        api响应结果
+     * @param timeoutMillis        期望响应时间
+     * @return 是否为有效json格式数据。
+     */
+    public static long withinTimeOut(RequestUnitTestsResult result, long timeoutMillis) {
+        if (result == null) {
+            return -1;
+        } else {
+            long durationMillis = result.durationMillis;
+
+            // 耗时是否超过期望值，超过期望值则fail
+            if (durationMillis > timeoutMillis) {
+                Assertions.fail("API did not respond within " + timeoutMillis + " ms");
+            }
+
+            return durationMillis;
+        }
+    }
+
+    /**
+     * 校验 URL 是否合法
+     * @param url        URL
+     * @return URL 是否合法
+     */
+    public static Boolean isValidUrl(String url) {
+        try {
+            URL parsedUrl = new URL(url);
+            String protocol = parsedUrl.getProtocol();
+            Boolean isValidUrl = protocol.equals("http") || protocol.equals("https");
+            if (!isValidUrl) {
+                Assertions.fail("Invalid URL: " + url);
+            }
+            return isValidUrl;
+        } catch (Exception e) {
+            Assertions.fail("Invalid URL: " + url);
+            return false;
+        }
+    }
+
+}

src/main/java/io/github/json031/unittests/RequestUnitTests.java

@@ -0,0 +1,110 @@
+package io.github.json031.unittests;
+
+import io.github.json031.JavaBean.RequestUnitTestsResult;
+import org.junit.jupiter.api.Assertions;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.client.RestTemplate;
+
+import java.util.Map;
+
+/**
+ * This class is used for unit testing api request.
+ */
+public class RequestUnitTests {
+
+    /**
+     * 单例实例
+     */
+    private static final RequestUnitTests INSTANCE = new RequestUnitTests();
+
+    /**
+     * 私有 RestTemplate 实例
+     */
+    private final RestTemplate restTemplate;
+
+    /**
+     * 私有构造函数
+     */
+    private RequestUnitTests() {
+        this.restTemplate = new RestTemplate();
+    }
+
+    /**
+     * 获取单例
+     */
+    public static RequestUnitTests getInstance() {
+        return INSTANCE;
+    }
+
+    /**
+     * 请求 API
+     *
+     * @param url           完整的 API 地址（包括 http/https）
+     * @param method        请求方式（GET / POST）
+     * @param params        请求参数（POST body 或 GET 查询参数）
+     * @param headers       请求头（可选）
+     * @param verbose       是否打印响应
+     * @return 响应数据
+     */
+    public static RequestUnitTestsResult requestWitRestTemplate(String url,
+                                                             HttpMethod method,
+                                                             Map<String, Object> params,
+                                                             Map<String, String> headers,
+                                                             boolean verbose) {
+        //校验 URL 是否合法
+        if (!DataUnitTests.isValidUrl(url)) {
+            return null;
+        }
+        try {
+            HttpHeaders httpHeaders = new HttpHeaders();
+            if (headers != null) {
+                headers.forEach(httpHeaders::set);
+            }
+
+            // 请求体
+            HttpEntity<?> entity;
+            // 请求地址
+            String finalUrl = url;
+
+            if (method == HttpMethod.GET && params != null && !params.isEmpty()) {
+                // 拼接 GET 参数
+                StringBuilder queryBuilder = new StringBuilder(url);
+                queryBuilder.append(url.contains("?") ? "&" : "?");
+                params.forEach((key, value) -> queryBuilder.append(key).append("=").append(value).append("&"));
+                finalUrl = queryBuilder.substring(0, queryBuilder.length() - 1); // 去掉最后一个 &
+                entity = new HttpEntity<>(httpHeaders);
+            } else {
+                // POST 请求体（可为 null）
+                entity = new HttpEntity<>(params, httpHeaders);
+            }
+
+            long start = System.nanoTime();
+
+            //校验finalUrl是否合法
+            if (!DataUnitTests.isValidUrl(finalUrl)) {
+                return null;
+            }
+            ResponseEntity<String> response = INSTANCE.restTemplate.exchange(finalUrl, method, entity, String.class);
+
+            long end = System.nanoTime();
+            // 毫秒级耗时
+            long durationMillis = (end - start) / 1_000_000;
+
+            if (verbose) {
+                System.out.println("API Response: " + response.getBody());
+                System.out.println("Response time: " + durationMillis + " ms");
+            }
+
+            RequestUnitTestsResult requestUnitTestsResult = new RequestUnitTestsResult(durationMillis, response);
+            return requestUnitTestsResult;
+
+        } catch (Exception e) {
+            Assertions.fail("API call failed for: " + url + " with error: " + e.getMessage());
+        }
+
+        return null;
+    }
+}