文档首页 > > API参考> CSE API> 契约> 修改微服务契约

修改微服务契约

分享
更新时间:2020/06/24 GMT+08:00

功能介绍

根据schema_id更新微服务的契约内容。

接口约束

服务中心老版本如果微服务环境定为production,不支持契约覆盖,从版本2.3.33开始,支持使用环境变量SCHEMA_EDITABLE支持契约覆盖

URI

PUT /v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户子项目的唯一标识。字符长度为1~64。

service_id

String

微服务唯一标识。字符长度为1~64。正则表达式为^.*$

schema_id

String

微服务契约唯一标识。字符长度为1~160。正则表达式为^[a-zA-Z0-9]{1,160}$|^[a-zA-Z0-9][a-zA-Z0-9_-.]{0,158}[a-zA-Z0-9]$

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-domain-name

String

租户账号名称。

表3 请求Body参数

参数

是否必选

参数类型

描述

schema

String

契约内容。

summary

String

新加入参数,后面创建schema,请尽量提供,shema的摘要

响应参数

状态码为 400 时:

表4 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码为 500 时:

表5 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

PUT https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id}

{
  "schema" : "---\nswagger: \"2.0\"\ninfo:\n  version: \"1.0.0\"\n  title: \"swagger definition for com.service.comment.controller.SimpleCtrlImpl\"\n  x-java-interface: \"cse.gen.blog.comment_service.Simple.SimpleCtrlImplIntf\"\nbasePath: \"/simple\"\nschemes:\n- \"https\"\nconsumes:\n- \"application/json\"\nproduces:\n- \"application/json\"\npaths:\n  /getname:\n    get:\n      operationId: \"getName\"\n      parameters:\n      - name: \"age\"\n        in: \"query\"\n        required: false\n        type: \"integer\"\n        format: \"int32\"\n      responses:\n        200:\n          description: \"response of 200\"\n          schema:\n            $ref: \"#/definitions/CommonResult\"\ndefinitions:\n  CommonResult:\n    type: \"object\"\n    required:\n    - \"resultCode\"\n    properties:\n      resultCode:\n        type: \"integer\"\n        format: \"int32\"\n      resultDesc:\n        type: \"string\"\n    x-java-class: \"com.service.comment.controller.CommonResult\"\n"
}

响应示例

状态码为 400 时:

{
  "errorCode" : "string",
  "errorMessage" : "string",
  "detail" : "string"
}

状态码为 500 时:

{
  "errorCode" : "string",
  "errorMessage" : "string",
  "detail" : "string"
}

状态码

状态码

描述

200

修改成功。

400

请求参数错误。

500

服务内部错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问