
# 检查用例规范 - CheckTestCaseFour
#### 功能介绍
此接口用于对单个用例进行规范性检查
测试 -\> 测试用例 -\> 点击用例进入用例详情 -\> 右上角用例规范检查
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。
#### URI
POST /v4/{project_id}/testcase/check
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                 |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) |
   
#### 请求参数
表2请求Body参数 
| 参数              | 是否必选 | 参数类型                                                                              | 描述                    |
|:---|:---|:---|:---|
| type            | 否    | String                                                                            | 类型,此值默认为TestCase,不用填写 |
| uri             | 否    | String                                                                            | 用例URI                 |
| steps           | 否    | Array of [TestCaseStepInfo] objects | 对外测试步骤                |
| name            | 是    | String                                                                            | 名称                    |
| preparation     | 否    | String                                                                            | 前置条件                  |
| remark          | 否    | String                                                                            | 备注                    |
| number          | 否    | String                                                                            | 用例编号                  |
| svn_script_path | 否    | String                                                                            | 脚本路径                  |
| feature_uri     | 否    | String                                                                            | 目录Uri                 |
| label_names     | 否    | Array of strings                                                                  | 对外用例操作时，标签名列表         |
| release_dev     | 否    | String                                                                            | 测试版本号                 |
| version_uri     | 否    | String                                                                            | 版本URI                 |
| min_similarity  | 否    | String                                                                            | 用例相似度下限（两位有效小数）       |
   
 表3TestCaseStepInfo 
| 参数            | 是否必选 | 参数类型   | 描述      |
|:---|:---|:---|:---|
| test_step     | 否    | String | 测试步骤    |
| expect_result | 否    | String | 预期结果    |
| step_actual   | 否    | String | 步骤的实际结果 |
| step_result   | 否    | String | 步骤结果    |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数    | 参数类型                                                                               | 描述      |
|:---|:---|:---|
| value | [TestCaseCheckResultVo] object | 请求返回的数据 |
   
 表5TestCaseCheckResultVo 
| 参数              | 参数类型                                                                             | 描述      |
|:---|:---|:---|
| total           | Integer                                                                          | 总数      |
| check_time      | String                                                                           | 检查时间    |
| check_timestamp | Long                                                                             | 检查时间时间戳 |
| version_uri     | String                                                                           | 版本URI   |
| version_name    | String                                                                           | 版本名称    |
| results         | Array of [TestCaseCheckVo] objects | 检查结果    |
   
 表6TestCaseCheckVo 
| 参数                  | 参数类型                                                                                                                     | 描述       |
|:---|:---|:---|
| num                 | Integer                                                                                                                  | 序号       |
| severity            | String                                                                                                                   | 严重程度     |
| rule_description    | String                                                                                                                   | 规则描述     |
| field               | String                                                                                                                   | 字段名称     |
| link                | String                                                                                                                   | 规则链接     |
| violation_cause     | String                                                                                                                   | 违规描述     |
| suggestions         | String                                                                                                                   | 修改建议     |
| hit_words           | Array of strings                                                                                                         | 命中词      |
| repeated_test_cases | Array of [TestCaseRuleCheckRepeatedTestCaseVo] objects | 重复用例信息列表 |
   
 表7TestCaseRuleCheckRepeatedTestCaseVo 
| 参数                         | 参数类型                                                                 | 描述        |
|:---|:---|:---|
| uri                        | String                                                               | 用例Uri     |
| name                       | String                                                               | 名称        |
| number                     | String                                                               | 用例编号      |
| rank                       | Integer                                                              | 用例等级      |
| service_type               | Integer                                                              | 服务类型      |
| preparation                | String                                                               | 前置前置条件    |
| steps                      | [TestCaseStepVo] object | 测试步骤      |
| feature_uri                | String                                                               | 目录Uri     |
| feature_name               | String                                                               | 目录名称      |
| version_uri                | String                                                               | 版本URI     |
| version_name               | String                                                               | 版本名称      |
| similarity                 | String                                                               | 用例相似度     |
| name_similarity            | String                                                               | 用例名称相似度   |
| preparation_similarity     | String                                                               | 用例前置条件相似度 |
| step_similarity            | String                                                               | 用例步骤描述相似度 |
| expected_result_similarity | String                                                               | 用例预期结果相似度 |
| test_steps_similarity      | String                                                               | 用例测试步骤相似度 |
   
 表8TestCaseStepVo 
| 参数            | 参数类型   | 描述   |
|:---|:---|:---|
| test_step     | String | 测试步骤 |
| expect_result | String | 预期结果 |
   
**状态码：400**
表9响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 接口调用失败错误码  |
| error_msg  | String | 接口调用失败错误信息 |
   
**状态码：401**
表10响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 接口调用失败错误码  |
| error_msg  | String | 接口调用失败错误信息 |
   
**状态码：404**
表11响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 接口调用失败错误码  |
| error_msg  | String | 接口调用失败错误信息 |
   
**状态码：500**
表12响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 接口调用失败错误码  |
| error_msg  | String | 接口调用失败错误信息 |
   
#### 请求示例
```
post https://{endpoint}/v4/704a12bbe517445ab75b855b77888d68/testcase/check
{
  "release_dev" : "",
  "number" : "101",
  "svn_script_path" : "ApiTest/资源迁移-执行_alpha/src/scripts/user/Case_ede226d1ea754b9fb3c5bece9e1422b1_2.java",
  "name" : "成功1",
  "remark" : " c",
  "label_names" : [ ],
  "steps" : [ {
    "test_step" : "",
    "expect_result" : ""
  } ],
  "feature_uri" : "",
  "preparation" : "",
  "uri" : "v92s000107oicdeu",
  "version_uri" : "v92t000107oi68nt"
}
```
#### 响应示例
**状态码：200**
OK
```
{
  "value" : {
    "total" : 2,
    "results" : [ {
      "num" : 1,
      "severity" : "严重",
      "field" : "步骤描述",
      "link" : "{url}",
      "suggestions" : "请编写测试步骤1描述",
      "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。",
      "violation_cause" : "违反规则7.1.1，测试步骤1描述为空"
    }, {
      "num" : 2,
      "severity" : "严重",
      "field" : "预期结果",
      "link" : "{url}",
      "suggestions" : "请编写测试步骤1预期结果",
      "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。",
      "violation_cause" : "违反规则7.1.1，测试步骤1预期结果为空"
    } ],
    "check_time" : "2025-06-18 17:56:35",
    "check_timestamp" : 1750240595395,
    "version_uri" : "v92t000107oi68nt",
    "version_name" : "基线"
  }
}
```
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 200 | OK                    |
| 400 | Bad Request           |
| 401 | Unauthorized          |
| 404 | Not Found             |
| 500 | Internal Server Error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。
