斷言腳本

斷言腳本用於驗證 API 回應是否符合你的預期。它們通常在測試期間使用，以自動檢查預期行為。

範例

斷言請求傳回的結果是否正確：

將傳回的資料寫入環境變數：

檢查回應主體是否包含指定字串。

語法參考

檢查回應主體是否為指定字串

檢查 json 輸出值

檢查標頭是否設定為 Content-Type

檢查請求回應時間是否少於 200 毫秒

檢查 HTTP 狀態碼是否為 200

檢查 HTTP 狀態碼名稱是否包含字串

檢查 POST 請求狀態碼是否正確。

如何使用斷言函式庫

Apidog 內建 ChaiJS 作為斷言函式庫。以下是常用斷言測試腳本的範例。如需更多範例，請查看 ChaiJS expect BDD library 文件。

斷言目標字串包含另一個字串

斷言目標嚴格等於（===）某個值

如果啟用 deep 旗標，斷言目標會是該值。

當你啟用 deep 旗標以使用 equal 和 property 斷言時，該旗標會讓後續斷言以遞迴方式比較物件的鍵值對，而不是比較物件本身。

斷言深度等於某個值，相當於 deep.equal(value)

斷言目前環境

斷言資料結構

TIP

我們建議在進行其他斷言之前，先使用 .a 方法檢查範本的資料類型。

資料類型區分大小寫。

檢查陣列是否為空

檢查使用 .a 方法後陣列是否為空

斷言目標物件的鍵值

斷言目標物件是否包含指定屬性

TIP

目標物件必須是 object、set、array 或 map。

如果 .keys 前面沒有 .all 或 .any，預設為 .all。

由於只有部分目標物件的資料類型可以搭配 .keys 方法使用，我們建議先使用 .a 方法斷言資料類型。

斷言目標物件的長度

斷言目標物件的成員（members）

TIP

預設情況下，.members 使用嚴格比較。

成員的順序不會影響結果。

斷言目標物件包含指定項目

我們建議在使用 .include 之前，先使用 .a 方法判斷資料類型。

範例：

範例#

語法參考#

檢查回應主體是否為指定字串#

檢查 json 輸出值#

檢查標頭是否設定為 Content-Type#

檢查請求回應時間是否少於 200 毫秒#

檢查 HTTP 狀態碼是否為 200#

檢查 HTTP 狀態碼名稱是否包含字串#

檢查 POST 請求狀態碼是否正確。#

如何使用斷言函式庫#

斷言目標字串包含另一個字串#

斷言目標嚴格等於（===）某個值#

斷言深度等於某個值，相當於 deep.equal(value)#

斷言目前環境#

斷言資料結構#

檢查陣列是否為空#

檢查使用 .a 方法後陣列是否為空#

斷言目標物件的鍵值#

斷言目標物件是否包含指定屬性#

斷言目標物件的長度#

斷言目標物件的成員（members）#

斷言目標物件包含指定項目#

範例

語法參考

檢查回應主體是否為指定字串

檢查 json 輸出值

檢查標頭是否設定為 Content-Type

檢查請求回應時間是否少於 200 毫秒

檢查 HTTP 狀態碼是否為 200

檢查 HTTP 狀態碼名稱是否包含字串

檢查 POST 請求狀態碼是否正確。

如何使用斷言函式庫

斷言目標字串包含另一個字串

斷言目標嚴格等於（===）某個值

斷言深度等於某個值，相當於 deep.equal(value)

斷言目前環境

斷言資料結構

檢查陣列是否為空

檢查使用 .a 方法後陣列是否為空

斷言目標物件的鍵值

斷言目標物件是否包含指定屬性

斷言目標物件的長度

斷言目標物件的成員（members）

斷言目標物件包含指定項目