如何透過 3 個步驟執行基本 API 測試

  2018 年 2 月 7 日

如果您正在尋找快速簡便的 API 呼叫來驗證您的 API 是否如預期般回應,那麼您來對地方了。當只需要快速檢查 API 時,API 測試工具可能會效率不彰。編寫程式碼可能也不是每個人的專長,這使得使用 Swagger Inspector 測試您的 API 成為任何層級測試人員的最佳選擇。

Swagger Inspector 允許任何人呼叫端點並查看結果,讓 API 測試變得輕而易舉。這不僅對測試很有幫助,對於探索您正在考慮整合的新 API,或者只是好奇您可以從中接收到什麼樣的資訊也很有幫助。它可以免費使用,而且不一定需要登入才能使用!

在本教學中,我們將介紹如何使用 Swagger Inspector 進行基本的 API 呼叫

在這個範例中,我們將使用星際大戰 API。主要是因為我最近看了《STAR WARS:原力覺醒》(我對這個主題有很多想法,不幸的是,這個部落格不是一篇關於《STAR WARS:原力覺醒》的評論文章,請推文給我們,如果您對這個主題也有任何想法...),但也因為它是一個內容很容易被各種人理解的 API。

您可以自由地跟著做,並使用您自己選擇的端點來變更範例。

步驟 1 – 登入

開啟 Inspector 並登入或註冊。如果您已經有 SwaggerHub 帳戶,您可以使用這些憑證登入。註冊可讓您 儲存 您的呼叫歷史記錄,並能夠產生一個OpenAPI 定義,當您準備好時。  

步驟 2 - 下載Chrome 擴充功能   

如果這是您第一次使用 Swagger Inspector,並且您嘗試檢查防火牆後面的 API,您需要下載 Swagger Inspector Chrome 擴充功能。您不需要

離開網站執行此操作。如果您使用的是 Safari,請在 Safari 的開發人員選項中「停用跨來源限制」。這將是存取許多 API 所需的。  

星際大戰 API 不需要下載擴充功能,但如果您想測試其他 API,那麼擴充功能對於您的測試成功至關重要。 

步驟 3 – 執行呼叫 

將您的端點貼到頁面頂端的列中 – 按下傳送。 

在這個範例中,我正在呼叫位於 https://swapi.co/api/people/13 資源下的 GET 方法。這裡有一個關於此資源將傳回哪些資訊的提示...

來源 - giphy

太棒了!看起來所有正確的資訊都已提供。

您已經正式完成基本 API 測試了。  使用 Swagger Inspector 就是這麼容易。沒有設定時間、沒有桌面下載、沒有等待時間。 

使用您自己的 API 端點試試看,或繼續使用星際大戰 API 來感受 Swagger Inspector 的運作方式。 繼續嘗試其他幾個端點以累積各種請求,並嘗試建立一個或兩個集合,然後產生 OpenAPI 定義! 

 若要深入瞭解 Swagger Inspector 如何幫助您實現 API 成功,請查看Swagger Inspector 頁面,並立即開始測試您的 API! 

我們還建立了一個影片示範,如果您覺得這種方式更適合您,可以跟著做。影片下方有文字記錄。 

立即試用 Swagger Inspector!

 文字記錄: 

嗨,我叫香儂,今天在這裡跟大家聊聊 Swagger Inspector。 

它是 Swagger 系列中最新的工具,我們對這項產品感到非常興奮! 

特別是它 建立 API 定義的能力非常棒,我們知道讓人們不斷回頭使用的是反覆進行 API 呼叫並對其進行分類的能力。 

 執行您與 API 互動時想要執行的所有操作,而且您需要一個  使用者介面來執行該操作。 

 使用此工具您可以執行的一件事是測試您的 API 端點。所以,我最喜歡的 API 是 目前是星際大戰 API。它 非常棒,您可以取得與星際大戰宇宙相關的行星。 

 呼叫星際大戰的 API,看看塔圖因行星在行星中排名第 1。 

 您可以使用 Swagger Inspector 快速輕鬆地進行 API 呼叫,並且還可以釘選您的 API 呼叫。 

 Y您可以執行一個 API 呼叫並說「好,這是我的最愛,我要繼續 進行這個 API 呼叫」。 

如果您改變主意,只需取消釘選請求,即可將這些請求新增到集合中以分類呼叫。 

您可以執行的另一件事是建立 API 定義,因此請在您的 API 呼叫歷史記錄中勾選,或者您可以直接進入集合並選取集合中的 所有 呼叫。 

選取集合中的特定呼叫並建立您的 API 定義。 

完成後,我們將自動產生此定義,因此如果您有多個 API 呼叫,則可以選取所有呼叫。 

我們正在幕後進行一些重構,以確保我們了解與您的 API 相關的路徑, 所有 您在使用 Swagger Inspector 時使用的查詢參數。 

最後,當您開始建立 API 時,我們會要求您提供一個名稱,然後根據我們從這些 API 呼叫中取得的所有資訊,來建立您的 API 定義。 

一旦您進入 SwaggerHub,您就可以在那裡擴展您的 API。 

加入任何細節,例如在這裡加入標題。這會儲存 API 和所有這些變更。 

您可以在 SwaggerHub 中儲存 API,並使用它們執行其他很棒的操作。 

這就是我今天關於 Swagger Inspector 的所有內容。 

Swagger Inspector 是免費的,我們計劃保持這樣!