服務契約指基于OpenAPI規范的微服務接口描述，是微服務系統運行和治理的基礎。您無需在應用中引入依賴，直接部署后，便可以通過服務契約在線查看微服務接口、路徑等API信息，不但能查詢提供的服務，還能方便的使用服務測試等功能。
背景信息
服務契約包含了以下3個主要功能：
- API查詢
查看服務提供者或消費者的重要API信息，包括方法名、參數列表、返回類型。Spring Cloud服務還支持查看請求方法、請求路徑、所屬類的類名等信息。
- Swagger注解解析
作為OpenAPI規范的主要制定者，Swagger雖并非是唯一支持OpenAPI的工具，但基本也屬于一種事實標準。
服務契約支持Swagger注解解析，并在控制臺的服務契約頁面進行展示：
- Swagger2的注解解析（例如@ApiOperation，@ApiParam，@ApiImplicitParam），解析value值在描述列展示。
- OpenAPI3的注解解析（例如@Operation，@Parameter），解析description值在描述列展示。
- 服務測試的前置條件
服務測試功能需要基于通過服務契約收集的服務的API信息，對服務接口或路徑進行測試。
操作步驟
登錄MSE治理中心控制臺，并在頂部菜單欄選擇地域。
在左側導航欄，選擇。
在服務查詢頁面，單擊目標服務名稱。
如果服務較多，可以通過服務名稱、IP、應用名進行模糊搜索。
在服務詳情面板，查看應用接口的基本信息、服務提供者、服務消費者、接口元數據和Metadata元數據。
當注解為Swagger時，方法和參數后將顯示相應信息。
文檔內容是否對您有幫助？