1天精通Apipost--全網最全gRPC調試和智能Mock講解

gRPC 接口調試

grpc

作爲一個老程序員,最近公司技術架構用到了gPRC,但國內很少有支持這個的工具,大部分都只是支持http。由於我同時也是Apipost骨灰級用戶,於是就在他們官網的問答社區裏提反饋,希望能支持一下gRPC函數調用,結果果然7.0版本我一更新,就看到Apipost已經支持gRPC了。

grpc調試工具

第一步:導入proto文件

導入proto文件後我們可以看到目錄區有導入的server和method

grpc在線調試工具

第二步:調試方法

選擇某個server下具體的方法,填寫入參和服務地址,就可以直接調用了!還可以選擇證書。

grpc在線調試工具 Apipost

Apipost跟postman的gRPC對比:

整體來說操作簡單,使用起來很方便,跟 postman 比較起來好用多了。postman 如果不是經常用需要摸索一番,你根本不知道它的使用流程是什麼樣的。所以對於國內研發人員來說,很值得推薦使用!

apipost 對比 postman

Apipost 上手指數:★★★★☆

Postman 上手指數:★★☆☆☆

其他類型接口調試

除了對 grpc 的支持,Apipost 同樣支持 http、websocket、socketjs、socketIO 類型的接口調試,可以說已經非常全了。

看到這裏,如果你僅僅以爲Apipost 只能做接口調試,那就錯啦,除了上面的,Apipost v7 還支持了 API設計 和 API調試校驗 2 大功能。

Api設計和智能Mock期望

作爲後端,被前端催着要接口已成爲工作中的添堵日常;而作爲前端,聯調時發現自己Mock的數據和後端對不上,更是令人崩潰。

針對於此,在後端還未提供真實接口的情況下,先拿到一份模擬響應的數據結構,就顯得非常重要,也就是我們所說的Mock。那麼如何寫出這種清晰規範,又能實時更新的動態Mock期望數據呢?當然不是自己動手,我們可以使用Apipost這款研發協同神器,來快速自動生成一篇理想狀態的Mock期望數據!

API設計——爲API文檔和數據Mock而生

Apipost7.0梳理並規範了研發環節的工作流程,其中關於接口Mock期望以及API文檔的產出,我們主要在“API設計”中完成。

【API設計-主頁面】

1、填寫基本信息

我們可以在“API設計”中設計並填寫接口的基本信息,包括接口請求方式、URL、請求參數以及返回的響應Mock數據期望等,與API調試模塊共用同一份數據源。在Apipost7.0版本,我們還支持了Digest auth、OAuth 1.0、Hawk Authentication、AWS Signature、NTML Authentication、Akamai EdgeGrid六種認證方式。

【API設計-請求區】

2、添加Mock響應期望

如下圖,我們可以通過可視化的操作界面快速生成我們想要的響應Mock期望。

添加Mock響應期望

Apipost支持自定義期望的名稱、狀態碼、內容格式(JSON、XML、 HTML、 Raw、 Binary)、觸發條件以及在此基礎上的一系列高級設置。

比如我們可以設置string、number、integer、array、object、Boolean、null、any八種字段類型,並支持定義該字段數據結構的具體細節,具體使用方法在這裏就不贅述了,感興趣的小夥伴可以去官網查看Apipost7.0版本的使用文檔。

【API設計-新建Mock期望】

設計好期望後,會有一個期望預覽,同時支持刷新生成新的數據,可以說是非常靈活方便了。

【API設計-Mock期望預覽】

3、進階:智能Mock期望

在同一個接口裏,由於我們對不同場景下返回的數據結構期望不同,我們可以通過設置多個期望的方式,來滿足這個需求。

設置好一堆期望後,下一步就該一個一個選期望,一個一個開始校驗了吧?當然你也可以這樣,但Apipost願意做的更進一步,最大程度提升我們的工作效率,於是就有了“智能期望”。我們可以在智能Mock期望中填寫一些觸發條件,開啓後,Apipost會根據已設置的觸發條件,自動匹配旗下的參數判斷規則,若滿足條件,則會啓用預設的期望。

【API設計-智能Mock期望 】

保存後,就會自動生成Mock URL鏈接。

當想要分享mock URL時,Apipost支持本地和雲端兩種方式分享,我們可以自定義是否要分享在雲服務上進行的mock,靈活保證數據安全。

【API設計-Mock url】

4、預覽/編輯/分享文檔

我們在API設計模塊所設置的全部內容,都可以自動生成一篇接口文檔,不僅如此,我們還支持了文檔編輯功能,最大程度保證交付出去的文檔,就是你心中所想的樣子。

【API設計-預覽、編輯文檔 】

在分享的時候,我們還可以自定義文檔的權限和有效期,並且支持內網分享,保證數據安全。

【API設計-分享文檔 】

Api調試和響應結果校驗

API調試:接口調試+校驗返回結果

下面這個頁面是不是很眼熟?Apipost7.0保留了6版本的基本分區,老用戶升級後不會覺得陌生,只會發現想要的功能已經都在裏面了。

【API調試-主頁面】

1.請求區

請求區相比6版本並未做太大改變,在API調試模塊中,如果想要更改API設計中的內容,可以點擊【去設計】按鈕,將會直接進入API設計頁面,並打開當前接口。

【API調試-請求區】

2.響應區

響應區內默認返回實時響應結果,點擊發送按鈕後,如果有數據返回,則會顯示返回數據,響應時間,響應碼,Cookie等。我們可以選擇在建立好的期望中生成示例,也可以直接新建一個示例。

【API調試-請求區】

看到這裏有的用戶就會問:“如果我只想新建一個示例,還非得去API設計裏先新建一個期望嗎?”答案是當然不用啦,我們不會綁架用戶非按我們的規矩來,Apipost是高度靈活自定義的,在爲您提供標準化的工作流程基礎上,也支持您多種工作場景下的使用。

我們可以在API調試模塊下新建一個示例,該示例與API設計中的期望是一一對應關係,每新建一個示例頭,API設計模塊中都會自動新建一個與之對應的期望,不用您親手設置,這邊都給自動生成好。

【API調試-新建示例】

API響應結果的自動校驗

API調試中的響應示例,與API設計中的Mock期望是一一對應關係,每新建一個示例頭,都會自動新建一個與之對應的Mock期望。同理,在API設計中建立的響應Mock期望,可以被引用到API調試的響應示例中,並可以通過校驗功能,判斷該響應Mock期望的響應結果是否符合預期。

如Mock期望內容與響應內容一致,則會提示校驗通過,即該接口返回的響應內容符合期望,當兩者不一致時,會提示具體錯誤信息並標明具體位置,方便我們及時定位問題。

【API調試-校驗返回結果】

最後,不得不說,技術更新太快了,真是不進步不行呀!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章