模拟接口

模拟接口管理 - 创建、模拟和组织Mock API的统一管理门户

---

从API生成关联的模拟API

POST

/api/v1/mock/apis/association/{mockServiceId}/{apisId}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

mockServiceId*

模拟服务ID

类型integer

必填

format"int64"

apisId*

接口ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/apis/association/{mockServiceId}/{apisId}

试验场

授权

UserHttpBearer

变量

键

值

mockServiceId*

apisId*

示例

cURL

JavaScript

PHP

Python

---

关联模拟接口与真实接口

PUT

/api/v1/mock/apis/association/{mockApisId}/{apisId}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

mockApisId*

模拟API接口ID

类型integer

必填

format"int64"

apisId*

接口ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/mock/apis/association/{mockApisId}/{apisId}

试验场

授权

UserHttpBearer

变量

键

值

mockApisId*

apisId*

示例

cURL

JavaScript

PHP

Python

---

全文搜索模拟API列表

GET

/api/v1/mock/apis/search

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

summary

类型string

source

类型string

枚举

"CREATED""ANGUS_IMPORT""COPY_APIS""ASSOC_APIS"

importSource

类型string

枚举

"OPENAPI""POSTMAN""ANGUS"

method

类型string

枚举

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

endpoint

类型string

mockServiceId*

类型integer

必填

format"int64"

assocProjectId

类型integer

format"int64"

assocApisId

类型integer

format"int64"

requestNum

类型integer

format"int64"

pushbackNum

类型integer

format"int64"

simulateErrorNum

类型integer

format"int64"

successNum

类型integer

format"int64"

exceptionNum

类型integer

format"int64"

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/apis/search

试验场

授权

UserHttpBearer

变量

键

值

id

summary

source

importSource

method

endpoint

mockServiceId*

assocProjectId

assocApisId

requestNum

pushbackNum

simulateErrorNum

successNum

exceptionNum

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与服务API之间的关联

DELETE

/api/v1/mock/apis/association

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

ids*

模拟API的ID

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/mock/apis/association

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

查询模拟API列表

GET

/api/v1/mock/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

summary

类型string

source

类型string

枚举

"CREATED""ANGUS_IMPORT""COPY_APIS""ASSOC_APIS"

importSource

类型string

枚举

"OPENAPI""POSTMAN""ANGUS"

method

类型string

枚举

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

endpoint

类型string

mockServiceId*

类型integer

必填

format"int64"

assocProjectId

类型integer

format"int64"

assocApisId

类型integer

format"int64"

requestNum

类型integer

format"int64"

pushbackNum

类型integer

format"int64"

simulateErrorNum

类型integer

format"int64"

successNum

类型integer

format"int64"

exceptionNum

类型integer

format"int64"

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/apis

试验场

授权

UserHttpBearer

变量

键

值

id

summary

source

importSource

method

endpoint

mockServiceId*

assocProjectId

assocApisId

requestNum

pushbackNum

simulateErrorNum

successNum

exceptionNum

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/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/mock/apis

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

添加模拟API接口

POST

/api/v1/mock/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/apis

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

删除模拟接口

DELETE

/api/v1/mock/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

ids*

模拟API的ID

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/mock/apis

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

更新模拟接口

PATCH

/api/v1/mock/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/mock/apis

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

将API同步到模拟服务实例

PUT

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

模拟API接口ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

将API迁移至另一个模拟服务

PATCH

/api/v1/mock/apis/move

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

targetServiceId*

目标模拟服务ID

类型integer

必填

format"int64"

请求体

application/json

[

0

]

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/mock/apis/move

试验场

授权

UserHttpBearer

变量

键

值

targetServiceId*

主体

示例

cURL

JavaScript

PHP

Python

---

克隆模拟接口

POST

/api/v1/mock/apis/{id}/clone

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

模拟API接口ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/apis/{id}/clone

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

查询模拟API的详细信息

GET

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

模拟API接口ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

从复制的API生成模拟API

POST

/api/v1/mock/apis/copy/{apisId}/{mockServiceId}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

mockServiceId*

模拟服务ID

类型integer

必填

format"int64"

apisId*

接口ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/mock/apis/copy/{apisId}/{mockServiceId}

试验场

授权

UserHttpBearer

变量

键

值

mockServiceId*

apisId*

示例

cURL

JavaScript

PHP

Python

---