跳转到内容

接口取消归档

个人工作区(未归档) - 用于管理未提交的接口及个人开发产物的私有暂存区


查询未归档API的详细信息

GET
/api/v1/apis/unarchived/{id}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

未归档的API ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

删除未归档的API

DELETE
/api/v1/apis/unarchived/{id}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

未归档的API ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

更新未归档的API

PATCH
/api/v1/apis/unarchived/{id}

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

全文搜索未归档的API

GET
/api/v1/apis/unarchived/search
UserHttpBearer

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

类型HTTP (bearer)

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
endpoint
类型string
summary
类型string
operationId
类型string
createdDate
类型string
format"date-time"
createdBy
类型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"

成功

*/*
JSON
"string"
授权
变量
cURL
JavaScript
PHP
Python

查询未归档的API列表

GET
/api/v1/apis/unarchived

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
endpoint
类型string
summary
类型string
operationId
类型string
createdDate
类型string
format"date-time"
createdBy
类型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"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

添加未归档的API

POST
/api/v1/apis/unarchived

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

删除所有未归档的API

DELETE
/api/v1/apis/unarchived

授权

UserHttpBearer

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

类型HTTP (bearer)

响应

成功

*/*
JSON
"string"

试验场

授权

示例

cURL
JavaScript
PHP
Python

查询未归档的API数量

GET
/api/v1/apis/unarchived/count

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

projectId*

项目ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

替换未归档API的名称

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

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

未归档的API ID

类型integer
必填
format"int64"

查询参数

name*

未归档的API名称

类型string
必填

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布