接口

接口管理 - 维护接口调试值、模式定义及版本历史的中央注册中心

---

查询API的详细信息

GET

/api/v1/apis/{id}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

查询参数

resolveRef*

解析引用标志，默认为false

类型boolean

必填

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

resolveRef*

示例

cURL

JavaScript

PHP

Python

---

检查API

GET

/api/v1/apis/{id}/check

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/{id}/check

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

克隆API

POST

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

查询与该API关联的模拟接口信息

GET

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

添加模拟API关联

POST

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

查询API的基本信息

GET

/api/v1/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

id

接口ID

类型integer

format"int64"

projectId*

项目ID

类型integer

必填

format"int64"

serviceId

服务ID

类型integer

format"int64"

protocol

类型string

枚举

"http""https""ws""wss"

method

类型string

枚举

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

summary

类型string

operationId

类型string

status

类型string

枚举

"UNKNOWN""IN_DESIGN""IN_DEV""DEV_COMPLETED""RELEASED"

admin

当应用管理员查询所有API时为必填项

类型boolean

hasPermission

当用户查询拥有该权限的API时为必填项

类型string

枚举

"VIEW""MODIFY""DELETE""DEBUG""TEST""GRANT""SHARE""RELEASE""EXPORT"

endpoint

类型string

ownerId

类型integer

format"int64"

createdDate

类型string

format"date-time"

createdBy

类型integer

format"int64"

favouriteBy

类型integer

format"int64"

followBy

类型integer

format"int64"

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

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

serviceId

protocol

method

summary

operationId

status

admin

hasPermission

endpoint

ownerId

createdDate

createdBy

favouriteBy

followBy

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

PUT

/api/v1/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/apis

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

删除API

DELETE

/api/v1/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

ids*

API 标识符

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/apis

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

更新API

PATCH

/api/v1/apis

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/apis

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询API的OpenAPI文档

GET

/api/v1/apis/{id}/openapi

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

查询参数

format

OpenAPI 文档格式。可选值为 yaml 或 json，默认值为 yaml

类型string

枚举

"yaml""json""yaml, json"

示例"yaml"

gzipCompression

是否开启Gzip压缩。建议启用gzip压缩，开启后数据大小可缩减20倍以上。默认情况下已启用gzip压缩

类型boolean

示例true

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/{id}/openapi

试验场

授权

UserHttpBearer

变量

键

值

id*

format

gzipCompression

示例

cURL

JavaScript

PHP

Python

---

查询api的服务器配置

GET

/api/v1/apis/{id}/schema/server

注意：数据源包含当前API请求服务器、服务器配置及父级服务的服务器配置

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/{id}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

替换API的服务器配置

PUT

/api/v1/apis/{id}/schema/server

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/apis/{id}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

删除该API的服务器

DELETE

/api/v1/apis/{id}/schema/server

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

查询参数

urls*

服务器URL

类型array

必填

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/apis/{id}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

id*

urls*

示例

cURL

JavaScript

PHP

Python

---

全文搜索API的基本信息

GET

/api/v1/apis/search

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

id

接口ID

类型integer

format"int64"

projectId*

项目ID

类型integer

必填

format"int64"

serviceId

服务ID

类型integer

format"int64"

protocol

类型string

枚举

"http""https""ws""wss"

method

类型string

枚举

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

summary

类型string

operationId

类型string

status

类型string

枚举

"UNKNOWN""IN_DESIGN""IN_DEV""DEV_COMPLETED""RELEASED"

admin

当应用管理员查询所有API时为必填项

类型boolean

hasPermission

当用户查询拥有该权限的API时为必填项

类型string

枚举

"VIEW""MODIFY""DELETE""DEBUG""TEST""GRANT""SHARE""RELEASE""EXPORT"

endpoint

类型string

ownerId

类型integer

format"int64"

createdDate

类型string

format"date-time"

createdBy

类型integer

format"int64"

favouriteBy

类型integer

format"int64"

followBy

类型integer

format"int64"

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

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

serviceId

protocol

method

summary

operationId

status

admin

hasPermission

endpoint

ownerId

createdDate

createdBy

favouriteBy

followBy

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

ids*

API 标识符

类型array

必填

maxItems200

minItems0

uniqueItemstrue

resolveRef*

解析引用标志，默认为false

类型boolean

必填

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/list/detail

试验场

授权

UserHttpBearer

变量

键

值

ids*

resolveRef*

示例

cURL

JavaScript

PHP

Python

---

更新API的名称

PUT

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

查询参数

name*

新API名称

类型string

必填

响应

成功

Content-Type

*/*

"string"

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

name*

示例

cURL

JavaScript

PHP

Python

---

替换API的所有服务器配置

PUT

/api/v1/apis/{id}/schema/server/all

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/apis/{id}/schema/server/all

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

将API迁移至另一服务

PATCH

/api/v1/apis/move

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/apis/move

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

修改API状态

PATCH

/api/v1/apis/{id}/status

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

查询参数

status*

API 状态

类型string

必填

枚举

"UNKNOWN""IN_DESIGN""IN_DEV""DEV_COMPLETED""RELEASED"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/apis/{id}/status

试验场

授权

UserHttpBearer

变量

键

值

id*

status*

示例

cURL

JavaScript

PHP

Python

---

导出API的OpenAPI规范

GET

/api/v1/apis/{id}/openapi/export

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

API标识

类型integer

必填

format"int64"

查询参数

format

OpenAPI 文档格式。可选值为 yaml 或 json，默认值为 yaml

类型string

枚举

"yaml""json""yaml, json"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/{id}/openapi/export

试验场

授权

UserHttpBearer

变量

键

值

id*

format

示例

cURL

JavaScript

PHP

Python

---

归档未归档的API

PUT

/api/v1/apis/archive

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/apis/archive

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---