XCan Cloud

English

简体中文

English

简体中文

Appearance

MockApisResponse​

Mock Response Definition and Management - Define and manage mock response templates (status codes, headers, body schemas)

Query the response of mock apis​

GET
/api/v1/mock/apis/{apisId}/response

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

apisId*

Mock apis id

类型integer
必填
format"int64"

响应​

OK

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

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Replace the response of mock apis​

PUT
/api/v1/mock/apis/{apisId}/response

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

apisId*

Mock apis id

类型integer
必填
format"int64"

请求体​

application/json
JSON
[
{
"name": "string",
"match": {
"path": {
"condition": "string",
"expression": "string",
"expected": "string"
},
"parameters": [
{
"name": "string",
"in": "string",
"condition": "string",
"expression": "string",
"expected": "string"
}
],
"body": {
"condition": "string",
"expression": "string",
"expected": "string"
},
"priority": 0
},
"content": {
"status": 0,
"headers": [
{
"name": "string",
"value": "string"
}
],
"contentEncoding": "string",
"content": "string",
"delay": {
"mode": "string",
"fixedTime": {
"value": 0,
"unit": "string"
},
"minRandomTime": {
"value": 0,
"unit": "string"
},
"maxRandomTime": {
"value": 0,
"unit": "string"
}
}
},
"pushback": {
"autoPush": true,
"method": "string",
"url": "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"
},
"delay": {
"mode": "string",
"fixedTime": {
"value": 0,
"unit": "string"
},
"minRandomTime": {
"value": 0,
"unit": "string"
},
"maxRandomTime": {
"value": 0,
"unit": "string"
}
}
}
}
]

响应​

OK

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

试验场​

授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Add the response of mock apis​

POST
/api/v1/mock/apis/{apisId}/response

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

apisId*

Mock apis id

类型integer
必填
format"int64"

请求体​

application/json
JSON
[
{
"name": "string",
"match": {
"path": {
"condition": "string",
"expression": "string",
"expected": "string"
},
"parameters": [
{
"name": "string",
"in": "string",
"condition": "string",
"expression": "string",
"expected": "string"
}
],
"body": {
"condition": "string",
"expression": "string",
"expected": "string"
},
"priority": 0
},
"content": {
"status": 0,
"headers": [
{
"name": "string",
"value": "string"
}
],
"contentEncoding": "string",
"content": "string",
"delay": {
"mode": "string",
"fixedTime": {
"value": 0,
"unit": "string"
},
"minRandomTime": {
"value": 0,
"unit": "string"
},
"maxRandomTime": {
"value": 0,
"unit": "string"
}
}
},
"pushback": {
"autoPush": true,
"method": "string",
"url": "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"
},
"delay": {
"mode": "string",
"fixedTime": {
"value": 0,
"unit": "string"
},
"minRandomTime": {
"value": 0,
"unit": "string"
},
"maxRandomTime": {
"value": 0,
"unit": "string"
}
}
}
}
]

响应​

OK

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

试验场​

授权
变量
键
值
主体

示例​

cURL
JavaScript
PHP
Python

Delete the response of mock apis​

DELETE
/api/v1/mock/apis/{apisId}/response

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

apisId*

Mock apis id

类型integer
必填
format"int64"

查询参数

responseIds*

Mock apis response ids

类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应​

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