使用inspector功能查看和管理契約

CSE從2.3.65版本（ServiceComb 1.2.0）開始，提供了inspector功能，該功能提供了用戶查看、下載契約，生成文檔和對API接口進(jìn)行測試的功能。這個(gè)功能直接在微服務(wù)提供，用于彌補(bǔ)通過服務(wù)中心查看契約和對接口進(jìn)行測試的不足。inspector功能后續(xù)會(huì)做進(jìn)一步增強(qiáng)，除了管理契約，還可以觀察微服務(wù)的內(nèi)部狀態(tài)，幫助定位一些常見問題。

·???????? 啟用inspector

在項(xiàng)目中啟用inspector很簡單，只需要在pom中增加如下依賴即可。

??????org.apache.servicecomb ??????inspector ????

然后啟動(dòng)微服務(wù)即可。下面假設(shè)微服務(wù)監(jiān)聽的端口為8080。

·???????? 使用inspector功能

inspector提供了管理界面，集成了swagger編輯器。輸入 http://localhost:8080/inspector/index.html 后，出現(xiàn)如下界面。

注意：該功能被設(shè)計(jì)為輔助開發(fā)、設(shè)計(jì)、運(yùn)維，第一次訪問的時(shí)候加載很慢。

SWAGER編輯界面

在SWAGGER編輯界面，可以對接口進(jìn)行測試。

HTML界面

HTML頁面提供了更容易讀寫的格式，方便開發(fā)者查看接口說明。

輸入 http://localhost:8080/inspector/schemas 可以查詢所有的schema列表

["goodsRepositoryApi","goodsService","onlineMallApi","stockApi","goodsCategoryApi","goodsPriceApi"]

輸入 http://localhost:8080/inspector/download/schemas?format=HTML 可以下載文檔。format支持HTML和SWAGGER兩種格式。這個(gè)接口會(huì)下載所有契約文件，打包為zip格式。

輸入 http://localhost:8080/inspector/schemas/goodsService?download=false&format=HTML 可以查看、下載單個(gè)契約文件。

CSE 契約

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。