7.3.1 查询微服务访问契约
功能介绍
根据指定的serviceId和schemaId查询微服务的schema信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /v4/{project_id}/registry/microservices/{serviceId}/schemas/{schemaId}
表7-27 路径参数
参数 类型 必选 说明
project_id String 是 ● 微服务引擎专业版，请填租户项目id，长度 为1~64。
● 微服务引擎专享版，请填固定值：
default。
serviceId String 是 微服务唯一标识。
字符长度为1~64。
正则表达式为^.*$
schemaId String 是 schema的id。
请求消息
表7-28 请求 Header 参数
参数 类型 必选 说明
Authorization String 是 若微服务引擎专享版开启了安全认证，此参数 必填。否则，无此参数。
开启了安全认证的微服务引擎专享版Token，
格式为：Authorization:Bearer{Token}
Token获取方法，请参考获取微服务引擎专享
版用户Token。
响应消息
响应参数
参数说明请参见表7-29。
表7-29 参数说明
参数 类型 说明
schema String 微服务契约内容。
示例
请求示例
GET /v4/default/registry/microservices/e0f0da073f2c91e8979a89ff2d7c69t6/schemas/com.test.TestService
响应示例
{"schema": "---\nswagger: \"2.0\"\ninfo:\n version: \"1.0.0\"\n title: \"swagger definition for com.service.provider.controller.ProviderImpl\"\n x-java-interface:
\"cse.gen.springmvc.provider.provider.ProviderImplIntf\"\nbasePath: \"/provider\"\nconsumes:\n-
\"application/json\"\nproduces:\n- \"application/json\"\npaths:\n /helloworld:\n get:\n operationId:
\"helloworld\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n required: true\n type: \"string\"\n responses:\n 200:\n description:
\"response of 200\"\n schema:\n type: \"string\"\n"}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
7.3.2 查询微服务的所有契约
功能介绍
查询一个微服务的所有契约信息，包括schemaId和summary信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /v4/{project_id}/registry/microservices/{serviceId}/schemas
表7-30 路径参数
参数 类型 必选 说明
project_id String 是 ● 微服务引擎专业版，请填租户项目id，长 度为1~64。
● 微服务引擎专享版，请填固定值：
default。
serviceId String 是 微服务唯一标识。
字符长度为1~64。
正则表达式为^.*$
表7-31 Query 参数
参数 类型 必选 说明
withSchema String 否 是否查询schema内容，默认为0。
● 0表示不显示schema内容，只有 schemaId和summary。
● 1表示显示schemaId、summary和 schema。
请求消息
表7-32 请求 Header 参数
参数 类型 必选 说明
Authorization String 是 若微服务引擎专享版开启了安全认证，此参数 必填。否则，无此参数。
开启了安全认证的微服务引擎专享版Token，
格式为：Authorization:Bearer{Token}
Token获取方法，请参考获取微服务引擎专享
版用户Token。
响应消息
参数说明请参见表7-33。
表7-33 参数说明
参数 类型 说明
schemas Array of objects 成功获取微服务所有schema结 构体的列表，具体参考
Schema。
示例
请求示例 无 响应示例
{ "schemas": [ {
"schemaId": "xxxx",
"schema": "xxxx", // 当url带withSchema=1参数才返回，默认不返回 "summary": "abcd"
} ] }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
7.3.3 修改微服务访问契约
功能介绍
根据schemaId更新微服务的访问契约内容。微服务引擎专业版默认不支持修改契约，
微服务引擎专享版默认支持修改契约。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v4/{project_id}/registry/microservices/{serviceId}/schemas/{schemaId}
表7-34 路径参数
参数 类型 必选 说明
project_id String 是 ● 微服务引擎专业版，请填租户项目id，长度为 1~64。
● 微服务引擎专享版，请填固定值：default。
serviceId String 是 微服务唯一标识。
字符长度为1~64。
正则表达式为^.*$
schemaId String 是 微服务契约唯一标识。
字符长度为1~160。
正则表达式为^[a-zA-Z0-9]{1,160}$|^[a-zA-Z0-9]
[a-zA-Z0-9_\-.]{0,158}[a-zA-Z0-9]$
请求消息
表7-35 请求 Header 参数
参数 类型 必选 说明
Authorizatio
n String 是 若微服务引擎专享版开启了安全认证，此参数必
填。否则，无此参数。
开启了安全认证的微服务引擎专享版Token，格式 为：Authorization:Bearer{Token}
Token获取方法，请参考获取微服务引擎专享版用
户Token。
表7-36 请求 Body 参数
参数 类型 必选 说明
schema String 是 微服务契约内容。
summary String 否 微服务契约摘要。
响应消息
响应参数 无
示例
请求示例
{ "schema": "string", "summary": "string"
}
响应示例 无
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。