API接口
添加API
-
基本数据添加请求
POST http://{{host}}:{{port}}/Api/addApi Content-Type: application/json token:{{token}} -
示例参数
{ "apiName": "测试添加", "apiURI": "http://192.168.87.177:8889/test", "apiProtocol": 0, "apiSuccessMock": "{\"code\":\"10000\"}", "apiFailureMock": "{\"code\":\"20000\"}", "apiRequestType": 0, "apiStatus": 0, "apiNoteType": 1, "apiNote": "", "apiNoteRaw": "", "apiRequestParamType": 0, "apiRequestRaw": "", "mockResult": "", "beforeInject": "", "afterInject": "", "projectID": 1, "lobId": 200, "moduleId": 200100, "subModuleId": -1, "beforeInterface": "", "afterInterface": "", "description": "", "demand": "", "demandId": 1, "principal": "", "platform": "", "version": "" } -
其余数据添加请求
POST http://{{host}}:{{port}}/Api/addApiOthers Content-Type: application/json token:{{token}} -
示例参数
{ "api": { "apiID": 624 }, "apiHeaders": [ { "headerName": "token", "headerValue": "token11111111" } ], "apiRequestParams": [ { "paramType": "0", "paramKey": "username", "paramValueList": [ { "valueDescription": "这是张三", "value": "张三" } ], "defaultParam": "0", "paramNotNull": "0", "paramName": "用户名字", "paramLimit": "必须是名字", "paramValue": "张三是飒飒" } ], "apiResultParams": [ { "paramKey": "code", "paramType": "0", "paramValueList": [ { "valueDescription": "失败", "value": "2000" }, { "valueDescription": "成功", "value": "1000" } ], "paramNotNull": "0", "paramName": "返回code" } ] } -
参数说明
-
api参数
参数名称 参数类型 参数说明 是否必需 备注 apiName String 接口名称 是 apiURI String 接口URI 是 apiProtocol int 请求协议 是 0-http,1-https apiSuccessMock String 成功示例 否 apiFailureMock Strnig 失败示例 否 apiRequestType int 请求类型 是 0-POST,1-GET,2-PUT,3-DELETE,4-HEAD,5-OPTIONS,6-PATCH apiStatus int 接口状态 是 0-启用,1-维护,2-弃用 apiNoteType int 文本类型 是 0-没有,1-富文本,2-markdown apiNote String markdown 否 apiNoteRaw String html 否 apiRequestParamType int 接口请求类型 是 0-表单,1-源数据,2-restful apiRequestRaw String 接口源数据 否 mockResult String mock数据 否 beforeInject String 前置注入 否 afterInject String 后置注入 否 projectID int 项目id 是 lobId int 业务线id 是 moduleId int 模块id 是 subModuleId int 子模块id 否 beforeInterface String 上游接口id 否 多个接口id以逗号分隔 afterInterface String 下游接口id 否 多个接口id以逗号分隔 description String 描述 否 demand String 需求 否 demandId int 需求id 否 principal String 负责人 否 platform String 调用方 否 version String 版本 是 -
apiHeaders参数
参数名称 参数类型 参数说明 是否必需 备注 headerName String header key 是 headerValue String header value 是 -
apiRequestParams
参数名称 参数类型 参数说明 是否必需 备注 paramName String 参数说明 是 paramKey String 参数名称 是 paramValue String 参数示例 否 paramType int 参数类型 是 见表格下 paramLimit String 参数限制 否 paramNotNull int 是否必填 是 0-必填,1-非必填 paramValueList 数组 参数可能值 否 defaultParam int 默认参数值 是 -
apiResultParams
参数名称 参数类型 参数说明 是否必需 备注 paramName String 参数说明 是 paramKey String 参数名称 是 paramType int 参数类型 是 见表格下 paramNotNull int 是否必填 是 0-必填,1-非必填 paramValueList 数组 参数可能值 否 paramType备注：0-String,1-json,2-int,3-float,4-double,5-date,6-datetime,7-boolean,8-byte,9-short,10-long,11-array,12-object,13-number,14-file
-
修改API
- 请求
POST http://{{host}}:{{port}}/Api/editApi
Content-Type: application/json
token:{{token}}
- 示例参数
{
"api": {
"apiID": 624,
"apiName": "测试添加xxx",
"apiURI": "http://192.168.87.177:8889/test",
"apiProtocol": 0,
"apiSuccessMock": "{\"code\":\"10000\"}",
"apiFailureMock": "{\"code\":\"20000\"}",
"apiRequestType": 0,
"apiStatus": 0,
"apiNoteType": 1,
"apiNote": "",
"apiNoteRaw": "",
"apiRequestParamType": 0,
"apiRequestRaw": "",
"mockResult": "",
"beforeInject": "",
"afterInject": "",
"projectID": 1,
"lobId": 200,
"moduleId": 200100,
"subModuleId": -1,
"beforeInterface": "",
"afterInterface": "",
"description": "",
"demand": "",
"demandId": 1,
"principal": "",
"platform": "",
"version": ""
},
"apiHeaders": [
{
"headerName": "token",
"headerValue": "token11111111"
}
],
"apiRequestParams": [
{
"paramType": "0",
"paramKey": "username",
"paramValueList": [
{
"valueDescription": "这是张三",
"value": "张三"
}
],
"default":"0",
"paramNotNull": 0,
"paramName": "用户名字",
"paramLimit": "必须是名字",
"paramValue": "张三是飒飒"
}
],
"apiResultParams": [
{
"paramKey": "code",
"paramType": "0",
"paramValueList": [
{
"valueDescription": "失败",
"value": "2000"
},
{
"valueDescription": "成功",
"value": "1000"
}
],
"paramNotNull": 0,
"paramName": "返回code"
}
]
}
获取API
-
请求
POST http://{{host}}:{{port}}/Api/getApi Content-Type: application/x-www-form-urlencoded projectID=2&apiID=624
用例接口
添加case
-
请求
POST http://{{host}}:{{port}}/AutomatedTestCase/addTestCase Content-Type: application/json token:{{token}} -
示例参数
{ "projectID": 1, "caseName": "demoData", "caseDesc": "demoData", "version": "demoData", "demandId": 1, "status": 1, "lobId": 200, "moduleId": 200100, "subModuleId": -1 } -
参数说明
projectID：项目名称 caseName：用例名字 caseDesc：用例描述 version：用例版本 demandId：需求id status：用例状态（0-启用，1-维护，2-弃用） lobId：业务线字段 moduleId：业务线字段 subModuleId：业务线字段
修改case
-
请求
POST http://{{host}}:{{port}}/AutomatedTestCase/editTestCase Content-Type: application/json token:{{token}} -
示例参数
{ "caseID" : 2, "projectID": 1, "caseName": "demoData1", "caseDesc": "demoData", "version": "demoData", "demandId": 1, "status": 1, "lobId": 200, "moduleId": 200100, "subModuleId": -1 } -
参数说明
caseID：caseId projectID：项目名称 caseName：用例名字 caseDesc：用例描述 version：用例版本 demandId：需求id status：用例状态（0-启用，1-维护，2-弃用） lobId：业务线字段 moduleId：业务线字段 subModuleId：业务线字段
获取case列表
-
请求
POST http://{{host}}:{{port}}/AutomatedTestCase/getTestCaseList Content-Type: application/x-www-form-urlencoded -
示例参数
projectId=1&lobId=200&moduleId=200100&subModuleId=-1 -
参数说明
projectId：项目id lobId：业务线字段 moduleId：业务线字段 subModuleId：业务线字段
单例接口
添加single
-
请求
POST http://{{host}}:{{port}}/AutomatedTestCaseSingle/addSingleTestCase Content-Type: application/json token:{{token}} -
示例参数
{ "caseID": 1, "caseData": "{}", "statusCode": "200", "matchType": 1, "matchRule": "[]", "apiURI": "http://192.168.87.177:8889/test", "apiName": "测试添加", "apiRequestType": 1, "status": 1, "projectId": 1, "lobId": 200, "moduleId": 200100, "subModuleId": -1 }- caseData示例
{ "auth": { "status": "1", "basicAuth": { "username": "123", "password": "456" } }, "headers": [ { "headerName": "token", "headerValue": "token11111111", "checkbox": true }, { "headerName": "", "headerValue": "", "checkbox": false } ], "URL": "http://192.168.87.177:8889/test", "params": [ { "paramKey": "username", "checkbox": true, "paramInfo": "张三" }, { "paramKey": "age", "checkbox": false, "paramInfo": "18" }, { "paramKey": "", "paramInfo": "", "checkbox": false } ], "requestType": 0, "raw":"qqq" }-
matchRule示例
[ { "paramKey": "code", "parent": ".", "matchRule": "1", "childList": [ { "paramKey": "codeChild", "paramInfo": "500", "childList": [], "matchRule": "3", "parent": ".code." }, { "paramKey": "", "paramInfo": "", "childList": [], "matchRule": "0", "parent": ".code." } ], "paramInfo": "10000" }, { "paramKey": "status", "parent": ".", "matchRule": "5", "childList": [], "paramInfo": "20000" }, { "paramKey": "", "parent": ".", "matchRule": "0", "paramInfo": "", "childList": [] } ]
-
参数说明
参数名称 参数类型 参数说明 是否必需 备注 caseID int 用例ID 是 caseData String 用例数据 是 见下 statusCode String 状态码 是 matchType int 匹配类型 是 0-完全校验,1-正则校验,2-json校验,3-不校验 matchRule String 匹配规则 否 见下 apiURI String 接口URI 是 apiName String 接口名称 是 apiRequestType int 请求类型 是 0-POST,1-GET,2-PUT,3-DELETE,4-HEAD,5-OPTIONS,6-PATCH status int 状态 是 0-未执行，1-成功，2-失败，3-校验失败 projectId int 项目id 是 lobId int 业务线id 是 moduleId int 模块id 是 subModuleId int 子模块id 是 -
caseData参数说明
参数名称 参数类型 参数说明 是否必需 备注 auth Object 验证类型 是 0-无验证，1-basicAuth headers Array 请求头 是 URL String 接口URI 是 params Array 参数 是 0-必填,1-非必填 requestType 请求方式 请求方式 是 0-表单,1-restful,2-源数据 raw String 源数据 否 -
matchRule参数说明
参数名称 参数类型 参数说明 是否必需 备注 paramKey String key 是 paramInfo String value 是 parent String 节点位置 是 matchRule String 匹配规则 是 0-不检验,1-等于,2-不等于,3-大于,4-小于,5-正则 childList Array 子字段 是
