HarGeneratorPlugin

Generuje pliki archiwum HTTP (HAR) z przechwyconych żądań i odpowiedzi.

Przykład konfiguracji

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

Właściwości konfiguracji

Majątek Description Default
includeSensitiveInformation Określa, czy w wygenerowanych plikach HAR mają być uwzględniane poufne informacje (nagłówki autoryzacji, pliki cookie itp.). W przypadku ustawienia wartości false, wartości poufnych nagłówków, plików cookie i poufnych parametrów zapytania są redagowane przy użyciu wartości REDACTED false
includeResponse Określa, czy uwzględnić zawartość treści odpowiedzi w wygenerowany plik HAR false

Opcje wiersza polecenia

Żaden

Uwagi

Format HAR (Archiwum HTTP) jest formatem opartym na formacie JSON na potrzeby rejestrowania transakcji HTTP. Różne narzędzia są szeroko obsługiwane i używane do:

  • Analizowanie ruchu sieciowego i wydajności
  • Debugowanie interakcji interfejsu API
  • Udostępnianie danych sesji HTTP
  • Importowanie do narzędzi deweloperskich przeglądarki i innych narzędzi do analizy

Gdy includeSensitiveInformation jest ustawiona wartość false, wtyczka automatycznie redaguje następujące poufne nagłówki:

  • 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

Wtyczka zastępuje również wartości wszystkich plików cookie żądań i odpowiedzi (request.cookies i response.cookies) przy REDACTEDzachowaniu nazw plików cookie.

Ponadto wtyczka redaguje wartości następujących poufnych parametrów zapytania (bez uwzględniania wielkości liter) w adresie URL żądania (request.url) i ciągu zapytania (request.queryString). Inne parametry zapytania przechowują swoje oryginalne wartości.

  • 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

Na przykład adres URL https://api.contoso.com/users?access_token=abc123&page=2 żądania jest rejestrowany jako https://api.contoso.com/users?access_token=REDACTED&page=2.

Wygenerowany plik HAR zawiera następujące elementy:

  • Szczegóły żądania HTTP (metoda, adres URL, nagłówki, parametry zapytania, pliki cookie)
  • Szczegóły odpowiedzi HTTP (stan, nagłówki, pliki cookie)
  • Dane treści żądania i odpowiedzi (jeśli dotyczy)
  • Typy i rozmiary zawartości
  • Informacje o wersji PROTOKOŁU HTTP

Wtyczka tworzy plik HAR o nazwie devproxy-{timestamp}.har w bieżącym katalogu po zatrzymaniu nagrywania.

Informacje dodatkowe

  • Ostatnia aktualizacja o