服務契約指基於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時,方法和參數後將顯示相應資訊。