服务架构

API元数据与模式管理 - 具备同步功能的OpenAPI元数据及JSON Schema定义管理

---

查询服务的额外外部文档

GET

/api/v1/services/{serviceId}/schema/externalDoc

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema/externalDoc

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

替换外部文档的服务引用

PUT

/api/v1/services/{serviceId}/schema/externalDoc

允许引用外部资源以扩展OpenAPI文档的说明文档

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/externalDoc

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

查询服务器的详细配置

GET

/api/v1/services/{serviceId}/schema/server/{serverId}

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

serverId*

服务器ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema/server/{serverId}

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

serverId*

示例

cURL

JavaScript

PHP

Python

---

替换服务的所有标签

PUT

/api/v1/services/{serviceId}/schema/tag/all

注意：标签的顺序可被解析工具用来反映其排列顺序。并非操作对象使用的所有标签都必须声明。未声明的标签可以随机组织，或基于工具的逻辑进行排列。

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/tag/all

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

查询服务的所有服务器配置

GET

/api/v1/services/{serviceId}/schema/server

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

替换服务的服务器配置

PUT

/api/v1/services/{serviceId}/schema/server

声明可在整个API中使用的服务器列表。有关服务器的更多详细信息，请参阅：OpenAPI规范#服务器对象

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

删除服务的服务器

DELETE

/api/v1/services/{serviceId}/schema/server

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

查询参数

ids*

服务器ID

类型array

必填

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{serviceId}/schema/server

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

ids*

示例

cURL

JavaScript

PHP

Python

---

查询服务的所有架构扩展

GET

/api/v1/services/{serviceId}/schema/extensions

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema/extensions

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

替换服务的所有模式扩展

PUT

/api/v1/services/{serviceId}/schema/extensions

更多信息，请参阅：规范扩展

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

{

"additionalProperties": {

}

}

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/extensions

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

查询服务的所有标签

GET

/api/v1/services/{serviceId}/schema/tag

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema/tag

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

替换服务的标签

PUT

/api/v1/services/{serviceId}/schema/tag

注意：标签的顺序可被解析工具用来反映其排列顺序。并非操作对象使用的所有标签都必须声明。未声明的标签可以随机组织，或基于工具的逻辑进行排列。

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/tag

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

删除服务的标签

DELETE

/api/v1/services/{serviceId}/schema/tag

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

查询参数

names*

报告名称

类型array

必填

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{serviceId}/schema/tag

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

示例

cURL

JavaScript

PHP

Python

---

查询服务的模式详情

GET

/api/v1/services/{serviceId}/schema

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

查询服务的所有安全要求

GET

/api/v1/services/{serviceId}/schema/securityRequirement

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema/securityRequirement

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

替换服务的安全需求

PUT

/api/v1/services/{serviceId}/schema/securityRequirement

关于可在整个API中使用的安全机制的声明。有关安全要求的更多详细信息，请参阅：OpenAPI规范#安全需求对象

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/securityRequirement

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

删除该服务的安全要求

DELETE

/api/v1/services/{serviceId}/schema/securityRequirement

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

查询参数

names*

安全架构名称

类型array

必填

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{serviceId}/schema/securityRequirement

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

示例

cURL

JavaScript

PHP

Python

---

查询项目的所有服务器配置

GET

/api/v1/services/schema/server

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

查询参数

projectId*

项目ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/schema/server

试验场

授权

UserHttpBearer

变量

键

值

projectId*

示例

cURL

JavaScript

PHP

Python

---

查询服务的架构信息

GET

/api/v1/services/{serviceId}/schema/info

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/schema/info

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

替换服务架构信息

PUT

/api/v1/services/{serviceId}/schema/info

提供关于API的元数据。注意：OpenAPI文档必须包含元数据，因此添加后不可删除

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/info

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

查询服务的OpenAPI文档

GET

/api/v1/services/{serviceId}/openapi

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

查询参数

format

OpenAPI 文档格式。可选值为 yaml 或 json，默认值为 yaml

类型string

枚举

"yaml""json""yaml, json"

示例"yaml"

gzipCompression

是否开启Gzip压缩。建议启用gzip压缩，开启后数据大小可缩减20倍以上。默认情况下已启用gzip压缩

类型boolean

示例true

apiIds

包含的API ID列表。未指定时默认包含所有API

类型array

uniqueItemstrue

onlyApisComponents

仅返回与API关联的组件，若为true则返回所有组件，默认为false

类型boolean

示例false

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/openapi

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

format

gzipCompression

apiIds

onlyApisComponents

示例

cURL

JavaScript

PHP

Python

---

替换服务的OpenAPI文档

PUT

/api/v1/services/{serviceId}/openapi

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

查询参数

forced*

强制修改

类型boolean

必填

gzipCompression*

是否开启Gzip压缩

类型boolean

必填

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/openapi

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

forced*

gzipCompression*

主体

示例

cURL

JavaScript

PHP

Python

---

OpenAPI规范文本翻译

PATCH

/api/v1/services/{id}/translate

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer

必填

format"int64"

查询参数

sourceLanguage*

目标语言

类型string

必填

枚举

"en""zh_CN"

targetLanguage*

目标语言

类型string

必填

枚举

"en""zh_CN"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/services/{id}/translate

试验场

授权

UserHttpBearer

变量

键

值

id*

sourceLanguage*

targetLanguage*

示例

cURL

JavaScript

PHP

Python

---

同步服务器配置到服务API

PUT

/api/v1/services/{serviceId}/schema/server/{serverId}/apis/sync

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

serverId*

服务器ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/server/{serverId}/apis/sync

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

serverId*

示例

cURL

JavaScript

PHP

Python

---

替换服务的所有服务器配置

PUT

/api/v1/services/{serviceId}/schema/server/all

API 可用服务器列表声明
注：本地服务器若在请求中不存在将被删除

有关服务器的更多详细信息，请参阅：OpenAPI 规范#服务器对象

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/server/all

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

替换该服务的所有安全要求

PUT

/api/v1/services/{serviceId}/schema/securityRequirement/all

关于可在整个API中使用的安全机制的声明。有关安全要求的更多详细信息，请参阅：OpenAPI规范#安全需求对象

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/schema/securityRequirement/all

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---