HarGeneratorPlugin

Generiert HAR-Dateien (HTTP Archive) aus den abgefangenen Anforderungen und Antworten.

Konfigurationsbeispiel

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

Konfigurationseigenschaften

Eigentum Description Standard
includeSensitiveInformation Bestimmt, ob vertrauliche Informationen (Autorisierungsheader, Cookies usw.) in die generierte HAR-Datei eingeschlossen werden sollen. Bei Festlegung auf false, werden Werte vertraulicher Header, Cookies und vertraulicher Abfrageparameter mit dem Wert redigiert. REDACTED false
includeResponse Bestimmt, ob der Inhalt des Antworttexts in die generierte HAR-Datei eingeschlossen werden soll. false

Befehlszeilenoptionen

Nichts

Bemerkungen

Das HAR-Format (HTTP Archive) ist ein JSON-basiertes Format zum Protokollieren von HTTP-Transaktionen. Verschiedene Tools unterstützen sie weit und verwendeten es für:

  • Analysieren von Netzwerkdatenverkehr und Leistung
  • Debuggen von API-Interaktionen
  • Freigeben von HTTP-Sitzungsdaten
  • Importieren in Browserentwicklertools und andere Analysetools

Wenn includeSensitiveInformation das Plug-In auf false festgelegt ist, werden die folgenden vertraulichen Header automatisch redigiert:

  • 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

Das Plug-In ersetzt auch die Werte aller Anforderungs- und Antwortcookies (request.cookies und response.cookies) durch REDACTED, während die Cookie-Namen beibehalten werden.

Darüber hinaus bearbeitet das Plug-In die Werte der folgenden vertraulichen Abfrageparameter (Groß-/Kleinschreibung) sowohl in der Anforderungs-URL (request.url) als auch in der Abfragezeichenfolge (request.queryString). Andere Abfrageparameter behalten ihre ursprünglichen Werte bei.

  • 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

Die Anforderungs-URL wird z. B https://api.contoso.com/users?access_token=abc123&page=2 . als https://api.contoso.com/users?access_token=REDACTED&page=2.

Die generierte HAR-Datei enthält:

  • HTTP-Anforderungsdetails (Methode, URL, Header, Abfrageparameter, Cookies)
  • HTTP-Antwortdetails (Status, Header, Cookies)
  • Anforderungs- und Antworttextdaten (falls zutreffend)
  • Inhaltstypen und -größen
  • HTTP-Versionsinformationen

Das Plug-In erstellt eine HAR-Datei devproxy-{timestamp}.har namens im aktuellen Verzeichnis, nachdem die Aufzeichnung beendet wurde.

Siehe auch

  • Zuletzt aktualisiert um