服务

API服务注册中心 - 统一管理API服务的生命周期

---

将API导入到服务

POST

/api/v1/services/import

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

multipart/form-data

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/services/import

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

导入服务示例

POST

/api/v1/services/example/import

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

projectId*

项目ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/services/example/import

试验场

授权

UserHttpBearer

变量

键

值

projectId*

示例

cURL

JavaScript

PHP

Python

---

查询服务的详细信息

GET

/api/v1/services/{id}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer

必填

format"int64"

查询参数

joinSchema

是否关联服务架构信息标志

类型boolean

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

joinSchema

示例

cURL

JavaScript

PHP

Python

---

删除服务

DELETE

/api/v1/services/{id}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

全文搜索服务

GET

/api/v1/services/search

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

项目ID

类型integer

必填

format"int64"

name

服务名称

类型string

admin

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

类型boolean

hasPermission

当用户查询具有单一权限项目时必填

类型string

枚举

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

queryHasApis

类型boolean

queryHasMockService

类型boolean

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

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

admin

hasPermission

queryHasApis

queryHasMockService

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

---

查询服务列表

GET

/api/v1/services

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

项目ID

类型integer

必填

format"int64"

name

服务名称

类型string

admin

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

类型boolean

hasPermission

当用户查询具有单一权限项目时必填

类型string

枚举

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

queryHasApis

类型boolean

queryHasMockService

类型boolean

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

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

admin

hasPermission

queryHasApis

queryHasMockService

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

---

添加服务

POST

/api/v1/services

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/services

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

克隆服务

POST

/api/v1/services/{id}/clone

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/services/{id}/clone

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

从服务中导出API

POST

/api/v1/services/export

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/services/export

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

替换服务名称

PUT

/api/v1/services/{id}/name

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer

必填

format"int64"

查询参数

name*

新服务名称

类型string

必填

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{id}/name

试验场

授权

UserHttpBearer

变量

键

值

id*

name*

示例

cURL

JavaScript

PHP

Python

---

查询与该服务关联的模拟服务信息

GET

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

修改服务状态

PATCH

/api/v1/services/{id}/status

如果修改某个服务，该服务下的所有服务及API状态将同步被修改

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer

必填

format"int64"

查询参数

status*

服务状态

类型string

必填

枚举

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

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/services/{id}/status

试验场

授权

UserHttpBearer

变量

键

值

id*

status*

示例

cURL

JavaScript

PHP

Python

---