如何在 FastAPI 中有效記錄原始 HTTP 請求/回應主體？

在Python FastAPI 中記錄原始HTTP 請求/回應

要求：

擷取並保存特定的原始JSON路由請求和回應，資料大小在1MB 左右，不會顯著影響回應時間。

選項1：利用中間件

中間件概念

中間件會在每個請求到達端點之前攔截每個請求，並在到達客戶端之前進行回應，從而允許數據操作。但是，在中間件中使用請求正文流的問題是下游端點無法使用它。因此，我們將使用 set_body() 函數使其可用。

對於回應，請使用BackgroundTask

可以使用BackgroundTask 執行日誌記錄，這確保在回應完成後進行日誌記錄傳送給客戶端，避免回應時間延遲。

中間件範例

# Logging middleware
async def some_middleware(request: Request, call_next):
    req_body = await request.body()
    await set_body(request, req_body)
    response = await call_next(request)

    # Body storage in RAM
    res_body = b''
    async for chunk in response.body_iterator:
        res_body += chunk

    # Background logging task
    task = BackgroundTask(log_info, req_body, res_body)
    return Response(...)

# Endpoint using middleware
@app.post('/')
async def main(payload: Dict):
    pass

選項2：自訂APIRoute類別

APIRoute類擴充

透過建立自訂APIRoute類，我們可以控制請求和回應主體，將其使用限制為通過APIRouter 的特定路由。

重要注意事項

對於如果回應較大（例如串流媒體），自訂路由可能會因將整個回應讀入 RAM 而遇到 RAM 問題或客戶端延遲。因此，請考慮從自訂路由中排除此類端點。

自訂APIRoute 類別範例

class LoggingRoute(APIRoute):
    async def custom_route_handler(request: Request) -> Response:
        req_body = await request.body()
        response = await original_route_handler(request)

        # Response handling based on type
        if isinstance(response, StreamingResponse):
            res_body = b''
            async for item in response.body_iterator:
                res_body += item
            response = Response(...)
        else:
            response.body

        # Logging task
        task = BackgroundTask(log_info, req_body, response.body)
        response.background = task
        return response

# Endpoint using custom APIRoute
@router.post('/')
async def main(payload: Dict):
    return payload

選擇一個選項

這兩個選項都提供了記錄請求和回應資料的解決方案，而無需顯著影響響應時間。選項 1 允許一般日誌記錄，而選項 2 則提供需要日誌記錄的路由的精細控制。

以上是如何在 FastAPI 中有效記錄原始 HTTP 請求/回應主體？的詳細內容。更多資訊請關注PHP中文網其他相關文章！