ApisShare

API Sharing Management - Unified management entrance for service and apis resource sharing

---

Query the sharing list of api

GET

/api/v1/apis/share

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Share id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

name

Share name

类型string

expiredDate

Share expired date

类型string

format"date-time"

shareScope

Share scope

类型string

枚举

"SERVICES""PARTIAL_APIS""SINGLE_APIS"

servicesId

Share services id

类型integer

format"int64"

createdBy

Share user id

类型integer

format"int64"

createdDate

Share date

类型string

format"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

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

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

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

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

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

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/share

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

expiredDate

shareScope

servicesId

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

---

Add the sharing of api

POST

/api/v1/apis/share

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"name": "string",

"remark": "string",

"expiredDate": "string",

"displayOptions": {

"includeServiceInfo": true,

"allowDebug": true,

"schemaStyle": "string"

},

"shareScope": "string",

"servicesId": 0,

"apisIds": [

0

],

"baseUrl": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/apis/share

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete the sharing of api

DELETE

/api/v1/apis/share

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Apis sharing ids

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/apis/share

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update the sharing of api

PATCH

/api/v1/apis/share

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"name": "string",

"remark": "string",

"expiredDate": "string",

"displayOptions": {

"includeServiceInfo": true,

"allowDebug": true,

"schemaStyle": "string"

},

"shareScope": "string",

"servicesId": 0,

"apisIds": [

0

],

"baseUrl": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/apis/share

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the sharing detail of api

GET

/api/v1/apis/share/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Share id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/share/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the sharing of api

GET

/api/v1/apis/share/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Share id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

name

Share name

类型string

expiredDate

Share expired date

类型string

format"date-time"

shareScope

Share scope

类型string

枚举

"SERVICES""PARTIAL_APIS""SINGLE_APIS"

servicesId

Share services id

类型integer

format"int64"

createdBy

Share user id

类型integer

format"int64"

createdDate

Share date

类型string

format"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

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

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

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

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

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

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/share/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

expiredDate

shareScope

servicesId

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

---