Add api health test

Author: Json031

pom.xml

@@ -5,7 +5,7 @@
   <groupId>io.github.json031</groupId>
   <artifactId>mcunittests</artifactId>
   <packaging>jar</packaging>
-  <version>1.0.8</version>
+  <version>1.0.9</version>
   <name>mcunittests</name>
   <description>mcunittests是SpringBoot项目的一个单元测试库，是一个在MIT许可下分发的开源项目</description>
   <url>https://github.com/Json031/mcunittests</url>

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

@@ -73,8 +73,33 @@ public void testApiReturnsValidJson(String url,
             Assertions.fail("API did not respond valid json, url: " + url);
         } else {
             ResponseEntity<String> response = result.response;
-            DataUnitTests.isValidJSON(response.getBody());
+            DataUnitTests.isValidJSON(response);
         }
     }
 
+
+    /**
+     * 通用测试方法，验证 API 是否正常运行。
+     *
+     * @param url           完整的 API 地址（包括 http/https）
+     * @param method        请求方式（GET / POST）
+     * @param params        请求参数（POST body 或 GET 查询参数）
+     * @param headers       请求头（可选）
+     * @param verbose       是否打印响应
+     */
+    public void testApiHealth(String url,
+                              HttpMethod method,
+                              Map<String, Object> params,
+                              Map<String, String> headers,
+                              long timeoutMillis,
+                              boolean verbose) {
+        RequestUnitTestsResult result = RequestUnitTests.requestWitRestTemplate(url, method, params, headers, verbose);
+        if (result == null) {
+            Assertions.fail("API did not respond : " + url);
+        } else {
+            ResponseEntity<String> response = result.response;
+            DataUnitTests.isValidJSON(response);
+            DataUnitTests.withinTimeOut(result, timeoutMillis);
+        }
+    }
 }

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

@@ -56,9 +56,13 @@ public HighConcurrencyResult highConcurrencyTestWithTimeoutMillis(String url,
                                                                       Map<String, String> headers,
                                                                       long timeoutMillis,
                                                                       boolean verbose) {
+        //create an executor to manager api request thread
         ExecutorService executor = Executors.newFixedThreadPool(threadCount);
+        //the api request thread results
         List<Future<Long>> futures = new ArrayList<>();
+        //thread safe for logging success count
         AtomicInteger successCount = new AtomicInteger();
+        //thread safe for logging fail count
         AtomicInteger failCount = new AtomicInteger();
 
         for (int i = 0; i < threadCount; i++) {

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

@@ -3,6 +3,9 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.github.json031.JavaBean.RequestUnitTestsResult;
 import org.junit.jupiter.api.Assertions;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
 
 import java.net.URL;
 
@@ -13,17 +16,22 @@ public class DataUnitTests {
 
     /**
      * 验证是否为有效json格式数据。
-     * @param json        数据
+     * @param response     api请求结果
      * @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);
+    public static <T> Boolean isValidJSON(ResponseEntity<T> response) {
+        if (DataUnitTests.isJSONContentType(response)) {
+            String json = (String) response.getBody();
+            // 用 Jackson 尝试解析 JSON
+            ObjectMapper mapper = new ObjectMapper();
+            try {
+                mapper.readTree(json);  // 验证数据是否为合法JSON格式数据
+                return true;
+            } catch (Exception e) {
+                Assertions.fail("Invalid JSON data: " + json);
+                return false;
+            }
+        } else {
             return false;
         }
     }
@@ -69,4 +77,53 @@ public static Boolean isValidUrl(String url) {
         }
     }
 
+    /**
+     * 获取getMediaType
+     * @param result     api请求结果
+     * @return MediaType
+     */
+    public static MediaType getMediaType(RequestUnitTestsResult result) {
+        return DataUnitTests.getMediaType(result.response);
+    }
+    /**
+     * 获取getMediaType
+     * @param response     api请求结果
+     * @return MediaType
+     */
+    public static <T> MediaType getMediaType(ResponseEntity<T> response) {
+        HttpHeaders responseHeaders = response.getHeaders();
+        MediaType contentType = responseHeaders.getContentType();
+        return contentType;
+    }
+    /**
+     * ContentType是否为application/json
+     * @param response     api请求结果
+     * @return Boolean 是否为application/json
+     */
+    public static <T> Boolean isJSONContentType(ResponseEntity<T> response) {
+        MediaType contentType = DataUnitTests.getMediaType(response);
+        return DataUnitTests.isJSONContentType(contentType);
+    }
+    /**
+     * ContentType是否为application/json
+     * @param result     api请求结果
+     * @return Boolean 是否为application/json
+     */
+    public static Boolean isJSONContentType(RequestUnitTestsResult result) {
+        MediaType contentType = DataUnitTests.getMediaType(result.response);
+        return DataUnitTests.isJSONContentType(contentType);
+    }
+    /**
+     * ContentType是否为application/json
+     * @param contentType   api请求结果response.headers.contentType
+     * @return Boolean 是否为application/json
+     */
+    public static Boolean isJSONContentType(MediaType contentType) {
+        if (contentType != null) {
+            if (MediaType.APPLICATION_JSON.includes(contentType)) {
+                return true;
+            }
+        }
+        return false;
+    }
 }