XCan Cloud

English

简体中文

English

简体中文

Appearance

ApisCase​

API Test Case Management - For storing and managing interface testing cases and assertion rules

Query the list of apis functional test cases​

GET
/api/v1/apis/case

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

id
类型integer
format"int64"
projectId
类型integer
format"int64"
serviceId
类型integer
format"int64"
apisId
类型integer
format"int64"
name
类型string
enabled

Enable test cases flag default is enabled

类型boolean
type

Apis test cases type, default is USER_DEFINED

类型string
枚举
"SMOKE""SECURITY""BUSINESS""USER_DEFINED"
testMethod

Apis test cases method, default is NULL

类型string
枚举
"EQUIVALENCE_PARTITIONING""BOUNDARY_VALUE_ANALYSIS""DECISION_TABLE_TESTING""CAUSE_EFFECT_GRAPHING""SCENARIO_TESTING""ERROR_GUESSING""STATE_TRANSITION_TESTING""RANDOM_TESTING""OTHER_TESTING"
protocol
类型string
枚举
"http""https""ws""wss"
method
类型string
枚举
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
endpoint
类型string
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

Page data size, default 10, maximum 2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
枚举
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
枚举
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Replace apis functional test cases​

PUT
/api/v1/apis/case

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
{
"id": 0,
"apisId": 0,
"enabled": true,
"type": "string",
"testMethod": "string",
"name": "string",
"description": "string",
"protocol": "http",
"method": "GET",
"endpoint": "/comm/api/v1/country/{id}",
"currentServer": {
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
},
"parameters": [
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
],
"requestBody": {
"format": "string",
"contentEncoding": "string",
"forms": [
{
"name": "string",
"description": "string",
"enabled": "true",
"type": "string",
"format": "string",
"contentType": "string",
"contentEncoding": "string",
"value": "string",
"fileName": "string",
"x-xc-value": "string",
"x-xc-contentEncoding": "string",
"x-xc-contentType": "string",
"x-xc-fileName": "string"
}
],
"rawContent": "string",
"fileName": "string"
},
"authentication": {
"type": "string",
"description": "string",
"name": "string",
"get$ref": "string",
"in": "string",
"scheme": "string",
"bearerFormat": "string",
"flows": {
"implicit": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"password": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"clientCredentials": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"authorizationCode": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"extensions": {
"additionalProperties": {
}
}
},
"openIdConnectUrl": "string",
"extensions": {
"additionalProperties": {
}
}
},
"assertions": [
{
"name": "Assertion status",
"description": "Assertion response status must is 200.",
"enabled": true,
"type": "BODY",
"parameterName": "string",
"condition": "string",
"assertionCondition": "EQUAL",
"expression": "string",
"matchItem": 0,
"expected": 200,
"extraction": {
"name": "string",
"method": "string",
"expression": "string",
"matchItem": 0,
"defaultValue": "string",
"request": {
"method": "GET",
"url": "string",
"server": {
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
},
"endpoint": "string",
"authentication": {
"type": "string",
"in": "string",
"scheme": "string",
"name": "string",
"description": "string",
"enabled": "true",
"value": "string",
"apiKeys": [
{
"name": "Authorization",
"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
"x-xc-value": "string"
}
],
"oauth2": {
"clientCredentials": {
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": [
"string"
],
"clientId": "string",
"clientSecret": "string",
"clientIn": "string",
"username": "string",
"password": "string"
},
"password": {
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": [
"string"
],
"clientId": "string",
"clientSecret": "string",
"clientIn": "string",
"username": "string",
"password": "string"
},
"authFlow": "string",
"newToken": true,
"token": "string"
}
},
"parameters": [
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
],
"body": {
"format": "string",
"contentEncoding": "string",
"forms": [
{
"name": "string",
"description": "string",
"enabled": "true",
"type": "string",
"format": "string",
"contentType": "string",
"contentEncoding": "string",
"value": "string",
"fileName": "string",
"x-xc-value": "string",
"x-xc-contentEncoding": "string",
"x-xc-contentType": "string",
"x-xc-fileName": "string"
}
],
"rawContent": "string",
"fileName": "string"
},
"validSecurity": true
},
"location": "string",
"parameterName": "string",
"value": "string",
"finalValue": "string",
"failureMessage": "string"
},
"actualCondition": "string",
"actualExpected": "string",
"extractValue": "string",
"result": {
"failure": true,
"ignored": true,
"message": "string"
},
"success": true,
"enabledFlag": true,
"ignore": true
}
],
"datasetActionOnEOF": "string",
"datasetSharingMode": "string"
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Add apis functional test cases​

POST
/api/v1/apis/case

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
{
"apisId": 0,
"enabled": true,
"type": "string",
"testMethod": "string",
"name": "string",
"description": "string",
"protocol": "http",
"method": "GET",
"endpoint": "/comm/api/v1/country/{id}",
"currentServer": {
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
},
"parameters": [
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
],
"requestBody": {
"format": "string",
"contentEncoding": "string",
"forms": [
{
"name": "string",
"description": "string",
"enabled": "true",
"type": "string",
"format": "string",
"contentType": "string",
"contentEncoding": "string",
"value": "string",
"fileName": "string",
"x-xc-value": "string",
"x-xc-contentEncoding": "string",
"x-xc-contentType": "string",
"x-xc-fileName": "string"
}
],
"rawContent": "string",
"fileName": "string"
},
"authentication": {
"type": "string",
"description": "string",
"name": "string",
"get$ref": "string",
"in": "string",
"scheme": "string",
"bearerFormat": "string",
"flows": {
"implicit": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"password": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"clientCredentials": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"authorizationCode": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"extensions": {
"additionalProperties": {
}
}
},
"openIdConnectUrl": "string",
"extensions": {
"additionalProperties": {
}
}
},
"assertions": [
{
"name": "Assertion status",
"description": "Assertion response status must is 200.",
"enabled": true,
"type": "BODY",
"parameterName": "string",
"condition": "string",
"assertionCondition": "EQUAL",
"expression": "string",
"matchItem": 0,
"expected": 200,
"extraction": {
"name": "string",
"method": "string",
"expression": "string",
"matchItem": 0,
"defaultValue": "string",
"request": {
"method": "GET",
"url": "string",
"server": {
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
},
"endpoint": "string",
"authentication": {
"type": "string",
"in": "string",
"scheme": "string",
"name": "string",
"description": "string",
"enabled": "true",
"value": "string",
"apiKeys": [
{
"name": "Authorization",
"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
"x-xc-value": "string"
}
],
"oauth2": {
"clientCredentials": {
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": [
"string"
],
"clientId": "string",
"clientSecret": "string",
"clientIn": "string",
"username": "string",
"password": "string"
},
"password": {
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": [
"string"
],
"clientId": "string",
"clientSecret": "string",
"clientIn": "string",
"username": "string",
"password": "string"
},
"authFlow": "string",
"newToken": true,
"token": "string"
}
},
"parameters": [
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
],
"body": {
"format": "string",
"contentEncoding": "string",
"forms": [
{
"name": "string",
"description": "string",
"enabled": "true",
"type": "string",
"format": "string",
"contentType": "string",
"contentEncoding": "string",
"value": "string",
"fileName": "string",
"x-xc-value": "string",
"x-xc-contentEncoding": "string",
"x-xc-contentType": "string",
"x-xc-fileName": "string"
}
],
"rawContent": "string",
"fileName": "string"
},
"validSecurity": true
},
"location": "string",
"parameterName": "string",
"value": "string",
"finalValue": "string",
"failureMessage": "string"
},
"actualCondition": "string",
"actualExpected": "string",
"extractValue": "string",
"result": {
"failure": true,
"ignored": true,
"message": "string"
},
"success": true,
"enabledFlag": true,
"ignore": true
}
],
"datasetActionOnEOF": "string",
"datasetSharingMode": "string"
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Delete apis functional test cases​

DELETE
/api/v1/apis/case

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
0
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Update apis functional test cases​

PATCH
/api/v1/apis/case

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
{
"id": 0,
"testMethod": "string",
"name": "string",
"description": "string",
"protocol": "http",
"method": "GET",
"endpoint": "/comm/api/v1/country/{id}",
"currentServer": {
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
},
"parameters": [
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
],
"requestBody": {
"format": "string",
"contentEncoding": "string",
"forms": [
{
"name": "string",
"description": "string",
"enabled": "true",
"type": "string",
"format": "string",
"contentType": "string",
"contentEncoding": "string",
"value": "string",
"fileName": "string",
"x-xc-value": "string",
"x-xc-contentEncoding": "string",
"x-xc-contentType": "string",
"x-xc-fileName": "string"
}
],
"rawContent": "string",
"fileName": "string"
},
"authentication": {
"type": "string",
"description": "string",
"name": "string",
"get$ref": "string",
"in": "string",
"scheme": "string",
"bearerFormat": "string",
"flows": {
"implicit": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"password": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"clientCredentials": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"authorizationCode": {
"authorizationUrl": "string",
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"extensions": {
"additionalProperties": {
}
}
},
"openIdConnectUrl": "string",
"extensions": {
"additionalProperties": {
}
}
},
"assertions": [
{
"name": "Assertion status",
"description": "Assertion response status must is 200.",
"enabled": true,
"type": "BODY",
"parameterName": "string",
"condition": "string",
"assertionCondition": "EQUAL",
"expression": "string",
"matchItem": 0,
"expected": 200,
"extraction": {
"name": "string",
"method": "string",
"expression": "string",
"matchItem": 0,
"defaultValue": "string",
"request": {
"method": "GET",
"url": "string",
"server": {
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
},
"endpoint": "string",
"authentication": {
"type": "string",
"in": "string",
"scheme": "string",
"name": "string",
"description": "string",
"enabled": "true",
"value": "string",
"apiKeys": [
{
"name": "Authorization",
"value": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
"x-xc-value": "string"
}
],
"oauth2": {
"clientCredentials": {
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": [
"string"
],
"clientId": "string",
"clientSecret": "string",
"clientIn": "string",
"username": "string",
"password": "string"
},
"password": {
"tokenUrl": "string",
"refreshUrl": "string",
"scopes": [
"string"
],
"clientId": "string",
"clientSecret": "string",
"clientIn": "string",
"username": "string",
"password": "string"
},
"authFlow": "string",
"newToken": true,
"token": "string"
}
},
"parameters": [
{
"name": "string",
"in": "string",
"description": "string",
"required": true,
"deprecated": true,
"allowEmptyValue": true,
"get$ref": "string",
"style": "string",
"explode": true,
"allowReserved": true,
"schema": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": {
"type": [
"string"
],
"format": "string",
"if": "[Circular Reference]",
"then": "[Circular Reference]",
"else": "[Circular Reference]",
"get$anchor": "string",
"get$comment": "string",
"get$dynamicAnchor": "string",
"get$id": "string",
"get$ref": "string",
"get$schema": "string",
"get$vocabulary": "string",
"additionalItems": "[Circular Reference]",
"additionalProperties": {
},
"allOf": [
{
}
],
"anyOf": [
{
}
],
"const": {
},
"contains": "[Circular Reference]",
"contentEncoding": "string",
"contentMediaType": "string",
"contentSchema": "[Circular Reference]",
"default": {
},
"dependentRequired": {
"additionalProperties": [
]
},
"dependentSchemas": {
"additionalProperties": {
}
},
"deprecated": true,
"description": "string",
"discriminator": {
"propertyName": "string",
"mapping": {
"additionalProperties": "string"
},
"extensions": {
"additionalProperties": {
}
}
},
"enum": [
{
}
],
"example": {
},
"examples": [
{
}
],
"exclusiveMaximum": 0,
"exclusiveMinimum": 0,
"extensions": {
"additionalProperties": {
}
},
"externalDocs": {
"description": "Find more info here",
"url": "https://example.com",
"extensions": {
"additionalProperties": {
}
}
},
"items": "[Circular Reference]",
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"maxContains": 0,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minContains": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": "[Circular Reference]",
"oneOf": [
{
}
],
"pattern": "string",
"patternProperties": {
"additionalProperties": {
}
},
"prefixItems": [
{
}
],
"properties": {
"additionalProperties": {
}
},
"propertyNames": "[Circular Reference]",
"readOnly": true,
"required": [
"string"
],
"title": "string",
"unevaluatedItems": "[Circular Reference]",
"unevaluatedProperties": "[Circular Reference]",
"uniqueItems": true,
"writeOnly": true,
"xml": {
"name": "string",
"namespace": "string",
"prefix": "string",
"attribute": true,
"wrapped": true,
"extensions": {
"additionalProperties": {
}
}
}
},
"examples": {
"additionalProperties": {
}
},
"example": {
},
"content": {
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
}
}
],
"body": {
"format": "string",
"contentEncoding": "string",
"forms": [
{
"name": "string",
"description": "string",
"enabled": "true",
"type": "string",
"format": "string",
"contentType": "string",
"contentEncoding": "string",
"value": "string",
"fileName": "string",
"x-xc-value": "string",
"x-xc-contentEncoding": "string",
"x-xc-contentType": "string",
"x-xc-fileName": "string"
}
],
"rawContent": "string",
"fileName": "string"
},
"validSecurity": true
},
"location": "string",
"parameterName": "string",
"value": "string",
"finalValue": "string",
"failureMessage": "string"
},
"actualCondition": "string",
"actualExpected": "string",
"extractValue": "string",
"result": {
"failure": true,
"ignored": true,
"message": "string"
},
"success": true,
"enabledFlag": true,
"ignore": true
}
],
"datasetActionOnEOF": "string",
"datasetSharingMode": "string"
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Replace the name of apis functional test cases​

PUT
/api/v1/apis/case/{id}/name

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Case id

类型integer
必填
format"int64"

查询参数

name*

New case name

类型string
必填

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Clone the apis functional test cases​

POST
/api/v1/apis/case/clone

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
0
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Force synchronize the functional test cases to script​

PATCH
/api/v1/apis/case/syncToScript

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

apisId*

Apis id

类型integer
必填
format"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Enable or disable the functional test cases​

PATCH
/api/v1/apis/case/enabled

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

ids*

Case ids

类型array
必填
uniqueItemstrue
enabled*

Enabled or Disabled

类型boolean
必填

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the detail of apis functional test cases​

GET
/api/v1/apis/case/{id}

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Case ID

类型integer
必填
format"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Fulltext search the list of apis functional test cases​

GET
/api/v1/apis/case/search

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

查询参数

id
类型integer
format"int64"
projectId
类型integer
format"int64"
serviceId
类型integer
format"int64"
apisId
类型integer
format"int64"
name
类型string
enabled

Enable test cases flag default is enabled

类型boolean
type

Apis test cases type, default is USER_DEFINED

类型string
枚举
"SMOKE""SECURITY""BUSINESS""USER_DEFINED"
testMethod

Apis test cases method, default is NULL

类型string
枚举
"EQUIVALENCE_PARTITIONING""BOUNDARY_VALUE_ANALYSIS""DECISION_TABLE_TESTING""CAUSE_EFFECT_GRAPHING""SCENARIO_TESTING""ERROR_GUESSING""STATE_TRANSITION_TESTING""RANDOM_TESTING""OTHER_TESTING"
protocol
类型string
枚举
"http""https""ws""wss"
method
类型string
枚举
"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"
endpoint
类型string
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

Page data size, default 10, maximum 2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
枚举
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
枚举
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
授权
变量
键
值
cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.

Copyright © 2021-2025 XCan Cloud