模拟服务

模拟服务管理 - 用于组织模拟接口与虚拟运行时环境的统一配置中心

---

查询模拟服务列表

GET

/api/v1/mock/service

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

项目ID，创建服务时必填

类型integer

必填

format"int64"

name

类型string

nodeIp

类型string

nodeId

类型integer

format"int64"

source

类型string

枚举

"CREATED""FILE_IMPORT""ASSOC_SERVICE"

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方式

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

过滤条件（等于、不等于、大于等）

类型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

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

过滤条件（等于、不等于、大于等）

类型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

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

过滤条件（等于、不等于、大于等）

类型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

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/mock/service

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

nodeIp

nodeId

source

createdBy

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

替换模拟服务

PUT

/api/v1/mock/service

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/mock/service

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

添加模拟服务

POST

/api/v1/mock/service

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

删除模拟服务

DELETE

/api/v1/mock/service

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

模拟服务ID

类型array

必填

maxItems200

minItems0

uniqueItemstrue

force

强制删除标志

类型boolean

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/mock/service

试验场

授权

UserHttpBearer

变量

键

值

ids*

force

示例

cURL

JavaScript

PHP

Python

---

更新模拟服务

PATCH

/api/v1/mock/service

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/mock/service

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

将API导入到现有的模拟服务中

POST

/api/v1/mock/service/import

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

multipart/form-data

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service/import

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

基于该服务生成关联的模拟服务

POST

/api/v1/mock/service/association/services

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service/association/services

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

通过代理停止模拟服务

POST

/api/v1/mock/service/stop

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

0

]

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service/stop

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

从文件导入模拟服务

POST

/api/v1/mock/service/file/import

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

multipart/form-data

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service/file/import

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询模拟服务的详细信息

GET

/api/v1/mock/service/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

模拟服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/mock/service/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

删除模拟服务与API服务之间的关联

DELETE

/api/v1/mock/service/{id}/association

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

模拟服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/mock/service/{id}/association

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

导入模拟服务示例

POST

/api/v1/mock/service/example/import

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

projectId*

项目ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service/example/import

试验场

授权

UserHttpBearer

变量

键

值

projectId*

示例

cURL

JavaScript

PHP

Python

---

全文搜索模拟服务列表

GET

/api/v1/mock/service/search

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

项目ID，创建服务时必填

类型integer

必填

format"int64"

name

类型string

nodeIp

类型string

nodeId

类型integer

format"int64"

source

类型string

枚举

"CREATED""FILE_IMPORT""ASSOC_SERVICE"

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方式

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

过滤条件（等于、不等于、大于等）

类型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

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

过滤条件（等于、不等于、大于等）

类型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

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

过滤条件（等于、不等于、大于等）

类型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

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/mock/service/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

nodeIp

nodeId

source

createdBy

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

从现有的模拟服务中导出API

GET

/api/v1/mock/service/export

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

mockServiceId*

导出模拟服务ID

类型integer

必填

format"int64"

mockApiIds

导出API ID列表。当作用域为APIS时指定需导出的API，未指定时则导出全部

类型array

uniqueItemstrue

format

模拟API文档格式。可选值为yaml或json，默认值为yaml

类型string

枚举

"yaml""json""yaml, json"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/mock/service/export

试验场

授权

UserHttpBearer

变量

键

值

mockServiceId*

mockApiIds

format

示例

cURL

JavaScript

PHP

Python

---

基于该服务的关联模拟服务

PUT

/api/v1/mock/service/association/{mockServiceId}/{serviceId}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

mockServiceId*

模拟服务ID

类型integer

必填

format"int64"

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/mock/service/association/{mockServiceId}/{serviceId}

试验场

授权

UserHttpBearer

变量

键

值

mockServiceId*

serviceId*

示例

cURL

JavaScript

PHP

Python

---

将服务设置和API同步至模拟服务实例

PUT

/api/v1/mock/service/{id}/instance/sync

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

模拟服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/mock/service/{id}/instance/sync

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

通过代理启动模拟服务

POST

/api/v1/mock/service/start

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

0

]

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service/start

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询模拟服务关联的API ID列表

GET

/api/v1/mock/service/{id}/association/apis/id

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

模拟服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/mock/service/{id}/association/apis/id

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

导入模拟API示例

POST

/api/v1/mock/service/{id}/example/apis/import

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

模拟服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/service/{id}/example/apis/import

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---