ApisDesign

OpenAPI Design Management - Standardization hub for API specification development, version control, and compliance monitoring

---

Query the design list of apis

GET

/api/v1/apis/design

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

格式"int64"

projectId*

Project ID

类型integer

必填

格式"int64"

name

类型string

release

类型boolean

tenantId

类型integer

格式"int64"

createdBy

类型integer

格式"int64"

createdDate

类型string

格式"date-time"

lastModifiedBy

类型integer

格式"int64"

lastModifiedDate

类型string

格式"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

Page data size, default 10, maximum 2000

类型integer

格式"int32"

最大值2000

最小值1

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

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

release

tenantId

createdBy

createdDate

lastModifiedBy

lastModifiedDate

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

---

Replace the name of apis design

PUT

/api/v1/apis/design

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"name": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/design

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add the design of apis

POST

/api/v1/apis/design

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"projectId": 0,

"name": "string",

"openapiSpecVersion": "3.0.1"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/apis/design

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete the design of apis

DELETE

/api/v1/apis/design

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Apis design ids

类型array

必填

最大项数200

最小项数0

唯一项true

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/apis/design

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Generate the services of designed apis

PUT

/api/v1/apis/design/{id}/services/generate

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Design id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/design/{id}/services/generate

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Release the design of apis

PUT

/api/v1/apis/design/{id}/release

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Design id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/design/{id}/release

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Clone the design of apis

PUT

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

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Design id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Associate existing service and apis design

PUT

/api/v1/apis/design/services/{id}/associate

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Apis service id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/design/services/{id}/associate

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Replace the design content of apis

PUT

/api/v1/apis/design/content

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"openapi": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/apis/design/content

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Import the apis design

POST

/api/v1/apis/design/import

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

multipart/form-data

object

Project ID

格式"int64"

Design name

最小长度1

Apis specification content. API definition string content in json or yaml format, multiple files import is not supported

Apis specification file. API definition file in json or yaml format, multiple files need to be compressed into a zip file before uploading

格式"binary"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/apis/design/import

试验场

授权

UserHttpBearer

主体

projectId*

name*

content

file

示例

cURL

JavaScript

PHP

Python

---

Query the sharing detail of apis

GET

/api/v1/apis/design/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Design id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/design/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the design of apis

GET

/api/v1/apis/design/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

格式"int64"

projectId*

Project ID

类型integer

必填

格式"int64"

name

类型string

release

类型boolean

tenantId

类型integer

格式"int64"

createdBy

类型integer

格式"int64"

createdDate

类型string

格式"date-time"

lastModifiedBy

类型integer

格式"int64"

lastModifiedDate

类型string

格式"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

Page data size, default 10, maximum 2000

类型integer

格式"int32"

最大值2000

最小值1

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

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

release

tenantId

createdBy

createdDate

lastModifiedBy

lastModifiedDate

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

---

Export the designed OpenAPI specification of apis

GET

/api/v1/apis/design/export

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id*

Design ID

类型integer

必填

格式"int64"

format

OpenAPI document format. Available values yaml or json, the default value is yaml

类型string

有效值

"yaml""json""yaml, json"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/apis/design/export

试验场

授权

UserHttpBearer

变量

键

值

id*

format

示例

cURL

JavaScript

PHP

Python

---