HarGeneratorPlugin

Generuje soubory HTTP Archive (HAR) z zachycených požadavků a odpovědí.

Příklad konfigurace

{
  "$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
  }
}

Vlastnosti konfigurace

Vlastnictví Description Výchozí
includeSensitiveInformation Určuje, zda se mají do vygenerovaného souboru HAR zahrnout citlivé informace (autorizační hlavičky, soubory cookie atd.). Pokud je tato hodnota nastavená na false, hodnoty citlivých hlaviček, souborů cookie a parametrů citlivého dotazu se znovu zpracovávají s hodnotou. REDACTED false
includeResponse Určuje, zda se má do vygenerovaného souboru HAR zahrnout obsah textu odpovědi. false

Možnosti příkazového řádku

None

Poznámky

Formát HAR (archiv HTTP) je formát založený na formátu JSON pro protokolování transakcí HTTP. Různé nástroje ho široce podporují a používají se k:

  • Analýza síťového provozu a výkonu
  • Ladění interakcí rozhraní API
  • Sdílení dat relace HTTP
  • Import do vývojářských nástrojů prohlížeče a dalších analytických nástrojů

Pokud includeSensitiveInformation je nastavená hodnota false, modul plug-in automaticky aktualizuje následující citlivé hlavičky:

  • 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

Modul plug-in také nahrazuje hodnoty všech souborů cookie požadavků a odpovědí (request.cookies a response.cookies) REDACTEDa přitom zachovává názvy souborů cookie.

Modul plug-in navíc reaktuje hodnoty následujících citlivých parametrů dotazu (nerozlišují malá a velká písmena) v adrese URL požadavku (request.url) i řetězci dotazu (request.queryString). Ostatní parametry dotazu zachovávají původní hodnoty.

  • 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

Například adresa URL https://api.contoso.com/users?access_token=abc123&page=2 požadavku se zaznamená jako https://api.contoso.com/users?access_token=REDACTED&page=2.

Vygenerovaný soubor HAR obsahuje:

  • Podrobnosti požadavku HTTP (metoda, adresa URL, hlavičky, parametry dotazu, soubory cookie)
  • Podrobnosti odpovědi HTTP (stav, hlavičky, soubory cookie)
  • Data textu žádosti a odpovědi (pokud je k dispozici)
  • Typy a velikosti obsahu
  • Informace o verzi PROTOKOLU HTTP

Modul plug-in vytvoří soubor HAR pojmenovaný devproxy-{timestamp}.har v aktuálním adresáři po zastavení záznamu.

Viz také

  • Poslední aktualizace v