文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ ServiceComb API/ 契约/ 查询微服务的所有契约
更新时间：2024-11-21 GMT+08:00
查看PDF
分享

查询微服务的所有契约

功能介绍

查询一个微服务的所有契约信息，包括schemaId和summary信息。

URI

GET /v4/{project_id}/registry/microservices/{service_id}/schemas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String
  • 微服务引擎专业版，请填租户项目id，长度为1~64，获取方法请参考获取项目ID。也可以填固定值default。
  • 微服务引擎专享版，请填固定值：default。

service_id

是

String

微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。
表2 Query参数

参数

是否必选

参数类型

描述

withSchema

否

Integer

是否查询schema内容，默认为0。

0表示不显示schema内容，只有schema_id和summary。

1表示显示schema_id、summary和schema。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Authorization

否

String

若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。

开启了安全认证的微服务引擎专享版Token，格式为：

Authorization:Bearer {Token}

Token获取方法，请参考获取微服务引擎专享版用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

schemas

Array of Schema objects

契约列表。
表5 Schema

参数

参数类型

描述

schemaId

String

契约id。

schema

String

契约内容。

summary

String

契约的Summary。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

查询指定service_id的微服务的契约信息，显示schema_id、summary和schema信息。

GET /v4/{project_id}/registry/microservices/{service_id}/schemas?withSchema=1

响应示例

状态码： 200

查询成功。

{
	"schemas": [{
		"schemaId": "xxxxmvc",
		"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\"\nxxxx",
		"summary": "abcda7b4072ef2d7a5fc9aefccf03e5548029ae31c6cd5fc29da7685d6d9e14adea3"
	}]
}

状态码

状态码

描述

200

查询成功。

400

错误的请求。

500

服务内部错误。

错误码

请参见ServiceComb错误码。

父主题： 契约

相关文档