HarGeneratorPlugin

Menghasilkan file Arsip HTTP (HAR) dari permintaan dan respons yang disadap.

Contoh konfigurasi

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

Properti konfigurasi

Harta benda Description Bawaan
includeSensitiveInformation Menentukan apakah akan menyertakan informasi sensitif (header otorisasi, cookie, dll.) dalam file HAR yang dihasilkan. Saat diatur ke false, nilai header sensitif, cookie, dan parameter kueri sensitif diredaksi dengan nilai REDACTED false
includeResponse Menentukan apakah akan menyertakan konten isi respons dalam file HAR yang dihasilkan false

Opsi Baris Perintah

None

Komentar

Format HAR (Arsip HTTP) adalah format berbasis JSON untuk mencatat transaksi HTTP. Berbagai alat secara luas mendukungnya dan menggunakannya untuk:

  • Menganalisis lalu lintas dan performa jaringan
  • Interaksi API debug
  • Berbagi data sesi HTTP
  • Impor ke alat pengembang browser dan alat analisis lainnya

Ketika includeSensitiveInformation diatur ke false, plugin secara otomatis meredaksi header sensitif berikut:

  • 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

Plugin juga mengganti nilai semua cookie permintaan dan respons (request.cookies dan response.cookies) dengan REDACTED, sambil menyimpan nama cookie.

Selain itu, plugin meredaksi nilai parameter kueri sensitif berikut (tidak peka huruf besar/kecil) di URL permintaan (request.url) dan string kueri (request.queryString). Parameter kueri lainnya menyimpan nilai aslinya.

  • 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

Misalnya, URL https://api.contoso.com/users?access_token=abc123&page=2 permintaan dicatat sebagai https://api.contoso.com/users?access_token=REDACTED&page=2.

File HAR yang dihasilkan meliputi:

  • Detail permintaan HTTP (metode, URL, header, parameter kueri, cookie)
  • Detail respons HTTP (status, header, cookie)
  • Data isi permintaan dan respons (jika berlaku)
  • Tipe dan ukuran isi
  • Informasi versi HTTP

Plugin membuat file HAR bernama devproxy-{timestamp}.har di direktori saat ini setelah perekaman berhenti.

Baca juga

  • Terakhir diperbarui pada