你可以在專案設定中設定資料庫連線詳細資料。設定完成後,你可以在端點除錯與測試期間,透過在前置/後置處理器步驟中新增資料庫操作來使用這些連線。這可讓你無縫地從資料庫讀取或寫入資料。SQL Server:支援 SQL Server 2014 及更新版本
設定資料庫連線#
請依照以下步驟在 Apidog 中設定資料庫連線:1.
開啟 Project Settings → Database Connections。
3.
從可用選項中選擇資料庫類型,並填寫必要的連線資訊,例如主機、連接埠、資料庫名稱、使用者名稱和密碼。建議使用 variables 來填寫。完全以變數填寫的資料庫連線可以儲存在雲端以便協作。
4.
除了使用使用者名稱和密碼的本機連線方式外,你也可以透過 SSH tunnel 建立更安全的連線,以更好地保護資料傳輸。
使用資料庫連線#
你可以在端點請求的前置/後置處理器中新增「Database Operations」以參照資料庫連線。新增後,你可以在「Database Operations」中指定資料庫連線。1.
在 Run 分頁(Design Mode)或 Request 分頁(Request Mode)中,前往前置/後置處理器。
2.
將游標移至 Add PreProcessor 或 Add PostProcessor,並選擇 Database Operation。
3.
為資料庫操作命名並設定資料庫連線。請確保所選的「Database Connection」已正確設定。了解更多。 4.
輸入 SQL 命令。命令中支援 {{variables}} 等變數。
5.
啟用 Extract Result To Variable(支援 JSONPath),並視需要切換 Console Log。
6.
點擊 Send 以執行端點請求,並在主控台中查看結果。
如果你在自動化測試中使用 Database Operation——無論是作為測試步驟,或用於端點請求的前置/後置處理器——都可以依照上述相同步驟進行設定與使用。Apidog 支援標準 SQL 查詢,但不支援預存程序等複雜 SQL 操作。
重要注意事項#
在透過請求執行資料庫操作之前,請確保已正確儲存設定的資料庫連線:如果你的資料庫連線使用變數並儲存在雲端,請務必在相關變數的 Current Value 欄位中設定實際的資料庫詳細資料(例如主機、使用者名稱、密碼等)。或者,你也可以使用設定變數的方法來動態設定這些值。
如果資料庫連線使用固定文字並儲存在本機,你需要在 Project Settings → Database Connection 中輸入實際的資料庫詳細資料(例如主機、使用者名稱、密碼等)。
儲存機制與資料安全#
目前,Apidog 提供兩種儲存資料庫連線的方式:儲存在 Apidog Cloud:如果資料庫連線完全使用變數設定,則會以變數形式儲存在 Apidog 的雲端伺服器上。
儲存在本機:如果資料庫連線使用固定文字設定,則會以純文字形式儲存在本機設定檔中。
儲存機制之間的差異#
| 儲存機制 | 儲存方式 | 優點 | 缺點 |
|---|
| Cloud | 在設定中使用變數 | 1. 可與團隊成員進行更便利的協作。 2. 透過 CI、Runner 等方式執行測試情境時,你可以使用變數設定資料庫連線詳細資料,而不必維護本機檔案。 | ⚠️ 當在變數初始值中使用明文時,資料庫名稱和密碼等資料將以明文傳輸至 Apidog 的雲端伺服器,造成資料安全風險(使用變數的目前值會讓資料儲存在本機,消除此風險)。建議使用 vault variables 以避免資料安全風險。 |
| Local | 在設定中使用固定文字 | 儲存在本機,無安全風險 | 1. 協作性較差;每位團隊成員都必須個別設定資料庫連線。 2. 透過 CI、Runner 或類似工具執行測試情境時,你需要為資料庫連線維護專用的本機檔案。 |
為了在良好的使用者體驗與資料安全之間取得平衡,Apidog 建議將資料庫連線儲存在雲端,並使用 Vault variables 來確保資料安全。強烈不建議在與資料庫連線相關的變數初始值中使用明文,因為這可能導致重大的資料安全風險。