HarGeneratorPlugin

HTTP-archívumfájlokat hoz létre a lehallgatott kérésekből és válaszokból.

Példa konfigurációra

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "HarGeneratorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "harGeneratorPlugin"
    }
  ],
  "harGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/hargeneratorplugin.schema.json",
    "includeSensitiveInformation": false,
    "includeResponse": true
  }
}

Konfigurációs tulajdonságok

Ingatlan Description Alapértelmezett
includeSensitiveInformation Meghatározza, hogy bizalmas információkat (engedélyezési fejléceket, cookie-kat stb.) kell-e belefoglalni a létrehozott HAR-fájlba. A bizalmas fejlécek, cookie-k és bizalmas lekérdezési paraméterek értékeinek beállításakor falsea rendszer újradefiniálja az értéket REDACTED false
includeResponse Meghatározza, hogy a választörzs tartalma szerepeljen-e a létrehozott HAR-fájlban false

Parancssori beállítások

None

Megjegyzések

A HAR (HTTP Archive) formátum egy JSON-alapú formátum a HTTP-tranzakciók naplózásához. A különböző eszközök széles körben támogatják, és a következő célra használták:

  • Hálózati forgalom és teljesítmény elemzése
  • API-interakciók hibakeresése
  • HTTP-munkamenet adatainak megosztása
  • Importálás böngészőfejlesztői eszközökbe és más elemzőeszközökbe

Ha includeSensitiveInformation be van állítva false, a beépülő modul automatikusan újrakonfigurálja a következő bizalmas fejléceket:

  • authorization
  • cookie
  • from
  • proxy-authenticate
  • proxy-authorization
  • set-cookie
  • www-authenticate
  • x-api-key
  • x-auth-token
  • x-csrf-token
  • x-forwarded-for
  • x-real-ip
  • x-session-token
  • x-xsrf-token

A beépülő modul az összes kérés- és válasz-cookie (request.cookies és response.cookies) REDACTEDértékét is lecseréli a cookie-k nevének megőrzése mellett.

A beépülő modul emellett a kérelem URL-címébenrequest.url () és a lekérdezési sztringben (request.queryString) a következő bizalmas lekérdezési paraméterek (kis- és nagybetűk megkülönböztetése) értékeit is újradefiniálja. Más lekérdezési paraméterek megtartják az eredeti értékeket.

  • access_token
  • api_key
  • api-key
  • apikey
  • auth
  • client_secret
  • code
  • id_token
  • key
  • password
  • refresh_token
  • secret
  • sig
  • signature
  • token
  • x-amz-credential
  • x-amz-security-token
  • x-amz-signature
  • x-goog-credential
  • x-goog-signature

A kérelem URL-címét https://api.contoso.com/users?access_token=abc123&page=2 például a rendszer a következőként https://api.contoso.com/users?access_token=REDACTED&page=2rögzíti: .

A létrehozott HAR-fájl a következőket tartalmazza:

  • HTTP-kérés részletei (metódus, URL-cím, fejlécek, lekérdezési paraméterek, cookie-k)
  • HTTP-válasz részletei (állapot, fejlécek, cookie-k)
  • Kérelem- és választörzs adatai (ha vannak)
  • Tartalomtípusok és -méretek
  • HTTP-verzióinformációk

A beépülő modul a rögzítés leállása után létrehoz egy HAR-fájlt devproxy-{timestamp}.har az aktuális könyvtárban.

Lásd még

  • Utolsó frissítés időpontja: