文档首页 > > API参考> CSE API> 契约>

修改微服务契约

修改微服务契约

分享
更新时间:2021/05/26 GMT+08:00

功能介绍

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

接口约束

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

调试

您可以在API Explorer中调试该接口。

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

租户帐号名称。

X-Auth-Token

String

用户Token。

表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: |
  ---
  swagger: "2.0"
  info:
    version: "1.0.0"
    title: "swagger definition for com.service.comment.controller.SimpleCtrlImpl"
    x-java-interface: "cse.gen.blog.comment_service.Simple.SimpleCtrlImplIntf"
  basePath: "/simple"
  schemes:
  - "https"
  consumes:
  - "application/json"
  produces:
  - "application/json"
  paths:
    /getname:
      get:
        operationId: "getName"
        parameters:
        - name: "age"
          in: "query"
          required: false
          type: "integer"
  format: "int32"
        responses:
          200:
            description: "response of 200"
            schema:
              $ref: "#/definitions/CommonResult"
  definitions:
    CommonResult:
      type: "object"
      required:
      - "resultCode"
      properties:
        resultCode:
          type: "integer"
          format: "int32"
        resultDesc:
          type: "string"
      x-java-class: "com.service.comment.controller.CommonResult"

响应示例

状态码

状态码

描述

200

修改成功。

400

错误的请求。

500

服务内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品