HarGeneratorPlugin

Создает файлы HTTP-архива (HAR) из перехватанных запросов и ответов.

Пример конфигурации

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

Свойства конфигурации

Недвижимость Description По умолчанию
includeSensitiveInformation Определяет, следует ли включать конфиденциальную информацию (заголовки авторизации, файлы cookie и т. д.) в созданный HAR-файл. Если задано falseзначение , значения конфиденциальных заголовков, файлов cookie и параметров конфиденциальных запросов редактируются со значением REDACTED false
includeResponse Определяет, следует ли включать содержимое текста ответа в созданный HAR-файл. false

Параметры командной строки

None

Замечания

Формат HAR (АРХИВ HTTP) — это формат на основе JSON для ведения журнала транзакций HTTP. Различные средства широко поддерживают его и используют его для:

  • Анализ сетевого трафика и производительности
  • Отладка взаимодействий API
  • Предоставление общего доступа к данным сеанса HTTP
  • Импорт в средства разработчика браузера и другие средства анализа

Если includeSensitiveInformation задано значение false, подключаемый модуль автоматически редактирует следующие конфиденциальные заголовки:

  • 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

Подключаемый модуль также заменяет значения всех файлов cookie запроса и ответа (request.cookies и response.cookies) на REDACTED, сохраняя имена файлов cookie.

Кроме того, подключаемый модуль редактирует значения следующих параметров конфиденциальных запросов (без учета регистра) в URL-адресе запроса (request.url) и строке запроса (request.queryString). Другие параметры запроса сохраняют исходные значения.

  • 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

Например, URL-адрес https://api.contoso.com/users?access_token=abc123&page=2 запроса записывается как https://api.contoso.com/users?access_token=REDACTED&page=2.

Созданный HAR-файл включает в себя:

  • Сведения о HTTP-запросе (метод, URL-адрес, заголовки, параметры запроса, файлы cookie)
  • Сведения о ответе HTTP (состояние, заголовки, файлы cookie)
  • Запрос и текст ответа (если применимо)
  • Типы контента и размеры
  • Сведения о версии HTTP

Подключаемый модуль создает HAR-файл с именем devproxy-{timestamp}.har в текущем каталоге после остановки записи.

См. также

  • Последнее обновление: