當使用FastAPI進行單元測試時，一個重要的工具是TestClient類。TestClient類允許我們模擬對FastAPI應用程序的HTTP請求，并測試應用程序的響應。這使我們能夠在不啟動服務器的情況下對API進行全面的測試。

下面我將詳細講解TestClient的使用方法和常見操作：

安裝和導入TestClient

首先，確保你的項目已經安裝了FastAPI和pytest庫。然后，從FastAPI庫中導入TestClient類：

from fastapi.testclient import TestClient

創建TestClient實例

在編寫測試用例之前，我們需要創建一個TestClient實例。我們可以將應用程序實例傳遞給TestClient構造函數來創建它：

from fastapi import FastAPI

app = FastAPI()
client = TestClient(app)

這樣，我們就創建了一個TestClient實例client，并將我們的FastAPI應用程序app傳遞給它。

發送HTTP請求

TestClient提供了各種方法來發送不同類型的HTTP請求，包括get()、post()、put()、delete()等。你可以使用這些方法來測試API的不同端點和功能。

以下是一個使用TestClient發送GET請求的示例：

response = client.get("/items/42")

在這個例子中，我們使用TestClient的get()方法發送了一個GET請求到/items/42端點，并將響應存儲在response變量中。

斷言響應

接下來，我們可以使用斷言來驗證響應的內容、狀態碼和其他屬性是否符合預期。

以下是一些常見的斷言示例：

• 檢查響應的狀態碼：

assert response.status_code == 200

• 檢查響應的JSON內容：

assert response.json() == {"item_id": 42, "name": "Example Item"}

• 檢查響應的頭部信息：

assert response.headers["content-type"] == "application/json"

• 檢查響應的文本內容：

assert response.text == "Success"

你可以根據需要使用適當的斷言來驗證不同方面的響應。

傳遞請求參數和負載

對于某些請求，你可能需要傳遞查詢參數、路徑參數、請求體負載等。TestClient允許你使用關鍵字參數來傳遞這些信息。

以下是一些示例：

• 傳遞查詢參數：

response = client.get("/items", params={"category": "books"})

• 傳遞路徑參數：

response = client.get("/items/{item_id}", params={"item_id": 42})

• 傳遞請求體負載：

payload = {"name": "Example Item"} response = client.post("/items", json=payload)

你可以根據具體的請求需求使用關鍵字參數來傳遞查詢參數、路徑參數和請求體負載。例如，使用params參數傳遞查詢參數，使用json參數傳遞JSON格式的請求體負載。

處理響應

TestClient的響應對象提供了許多屬性和方法來處理和訪問響應的各個部分。

以下是一些常用的響應處理操作：

• 訪問響應的內容：

content = response.content

• 獲取響應的JSON內容：

json_data = response.json()

• 獲取響應的頭部信息：

headers = response.headers

• 檢查響應是否成功：

assert response.ok

• 獲取響應的狀態碼：

status_code = response.status_code

你可以根據測試需求使用適當的方法和屬性來處理和訪問響應。

完整示例

下面是一個完整的示例，展示了如何使用TestClient對FastAPI應用程序進行單元測試：

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id}

client = TestClient(app)

def test_read_item():
    response = client.get("/items/42")
    assert response.status_code == 200
    assert response.json() == {"item_id": 42}

在這個示例中，我們定義了一個簡單的GET路由處理函數read_item，它接受一個item_id路徑參數，并返回相應的JSON響應。然后，我們使用TestClient來發送GET請求到/items/42端點，并使用斷言驗證響應的狀態碼和JSON內容是否符合預期。

執行測試

要執行上述示例中的測試，你可以使用pytest來運行測試文件。在命令行中進入測試文件所在的目錄，并運行以下命令：

pytest test_example.py

pytest將自動發現并運行測試用例，并顯示測試結果。

這就是關于TestClient的詳細講解。通過使用TestClient，你可以方便地模擬HTTP請求并測試FastAPI應用程序的各個部分，確保其功能的正確性和一致性。