跳转到内容

服务组件

服务OpenAPI组件管理 - 跨服务集中管理OpenAPI组件(模式、响应、安全方案)


通过引用查询服务OpenAPI组件

GET
/api/v1/services/{serviceId}/comp

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"

查询参数

refs*

组件引用

类型array
必填
uniqueItemstrue
ignoreModel

忽略查询模型,默认为 false

类型boolean

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

通过引用删除服务OpenAPI组件

DELETE
/api/v1/services/{serviceId}/comp

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"

查询参数

refs*

组件引用

类型array
必填
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

通过引用查询服务OpenAPI组件

GET
/api/v1/services/{serviceId}/comp/all

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"

查询参数

ignoreModel

忽略查询模型,默认为 false

类型boolean

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

删除服务的所有OpenAPI组件

DELETE
/api/v1/services/{serviceId}/comp/all

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

替换服务OpenAPI组件

PUT
/api/v1/services/{serviceId}/comp/{type}/{key}

替换服务的OpenAPI组件。有关组件对象的更多详细信息,请参阅:OpenAPI规范#组件对象

(注:根据要求保留代码链接和格式不变,仅翻译说明性文本部分)

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"
type*

组件类型

类型string
必填
枚举
"schemas""responses""parameters""examples""requestBodies""headers""securitySchemes""links""callbacks""extensions""pathItems"
key*

组件键

类型string
必填

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

查询指定类型的服务OpenAPI组件

GET
/api/v1/services/{serviceId}/comp/type

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"

查询参数

types*

组件类型

类型array
必填
uniqueItemstrue
keys

组件键

类型array
uniqueItemstrue
ignoreModel

忽略查询模型,默认为 false

类型boolean

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

按类型删除服务OpenAPI组件

DELETE
/api/v1/services/{serviceId}/comp/{type}

根据服务类型删除OpenAPI组件。若组件键参数为空,则删除该类型下的所有组件

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"
type*

组件类型

类型string
必填
枚举
"schemas""responses""parameters""examples""requestBodies""headers""securitySchemes""links""callbacks""extensions""pathItems"

查询参数

keys

组件键

类型array
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

按引用查询服务OpenAPI组件

GET
/api/v1/services/{serviceId}/comp/ref

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer
必填
format"int64"

查询参数

ref*

组件引用

类型string
必填

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布