服务同步

OpenAPI文档同步配置 - 将服务实现与Swagger/OpenAPI文档同步

---

查询服务同步配置

GET

/api/v1/services/{serviceId}/synchronization

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/services/{serviceId}/synchronization

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

示例

cURL

JavaScript

PHP

Python

---

替换服务的同步配置

PUT

/api/v1/services/{serviceId}/synchronization

替换服务的同步配置，最多允许添加10条配置

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/synchronization

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

删除服务同步配置

DELETE

/api/v1/services/{serviceId}/synchronization

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

查询参数

names*

同步配置名称

类型array

必填

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/services/{serviceId}/synchronization

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

names*

示例

cURL

JavaScript

PHP

Python

---

替换服务的所有同步配置

PUT

/api/v1/services/{serviceId}/synchronization/all

替换所有服务的同步配置，最多允许添加10个配置

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/services/{serviceId}/synchronization/all

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

主体

示例

cURL

JavaScript

PHP

Python

---

测试同步配置

POST

/api/v1/services/synchronization/test

测试同步URL及授权信息是否配置正确

授权

UserHttpBearer

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

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/services/synchronization/test

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

执行服务同步

POST

/api/v1/services/{serviceId}/synchronization/exec

通过OpenAPI文档配置执行服务同步

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

serviceId*

服务ID

类型integer

必填

format"int64"

查询参数

name

同步配置名称，值为空时同步项目下所有OpenAPI文档

类型string

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/services/{serviceId}/synchronization/exec

试验场

授权

UserHttpBearer

变量

键

值

serviceId*

name

示例

cURL

JavaScript

PHP

Python

---