APIRequest

Предоставляет API для тестирования Web API. Этот класс используется для создания экземпляра APIRequestContext, который, в свою очередь, можно использовать для отправки веб-запросов. Экземпляр этого класса можно получить с помощью playwright.request. Дополнительные сведения см. в разделе APIRequestContext.

Методы​

newContext​

Создает новые экземпляры APIRequestContext.

Использование

await apiRequest.newContext();
await apiRequest.newContext(options);

Аргументы

• options Object (необязательно)

  • baseURL string (необязательно)

    Такие методы, как apiRequestContext.get(), учитывают базовый URL, используя конструктор URL() для создания соответствующего URL. Примеры:

    • baseURL: http://localhost:3000 и отправка запроса на /bar.html приводит к http://localhost:3000/bar.html
    • baseURL: http://localhost:3000/foo/ и отправка запроса на ./bar.html приводит к http://localhost:3000/foo/bar.html
    • baseURL: http://localhost:3000/foo (без завершающей косой черты) и переход на ./bar.html приводит к http://localhost:3000/bar.html

  • clientCertificates Array<Object> (необязательно)

    • origin string

      Точное происхождение, для которого действителен сертификат. Происхождение включает https протокол, имя хоста и, возможно, порт.

    • certPath string (необязательно)

      Путь к файлу с сертификатом в формате PEM.

    • cert Buffer (необязательно)

      Непосредственное значение сертификата в формате PEM.

    • keyPath string (необязательно)

      Путь к файлу с закрытым ключом в формате PEM.

    • key Buffer (необязательно)

      Непосредственное значение закрытого ключа в формате PEM.

    • pfxPath string (необязательно)

      Путь к файлу с закрытым ключом и цепочкой сертификатов в кодировке PFX или PKCS12.

    • pfx Buffer (необязательно)

      Непосредственное значение закрытого ключа и цепочки сертификатов в кодировке PFX или PKCS12.

    • passphrase string (необязательно)

      Парольная фраза для закрытого ключа (PEM или PFX).

    Аутентификация клиента TLS позволяет серверу запросить сертификат клиента и проверить его.

    Подробности

    Массив используемых сертификатов клиента. Каждый объект сертификата должен содержать либо оба поля certPath и keyPath, либо только pfxPath, либо соответствующие им непосредственные значения (cert и key или pfx). Если сертификат зашифрован, необходимо также указать свойство passphrase. Свойство origin должно точно соответствовать происхождению запроса, для которого действителен сертификат.

    Аутентификация клиента с помощью сертификата активна только в том случае, если указан хотя бы один сертификат клиента. Если требуется отклонять все сертификаты клиента, отправленные сервером, необходимо указать сертификат клиента с полем origin, которое не соответствует ни одному из доменов, которые планируется посещать.

    примечание

    При использовании WebKit в macOS доступ к localhost не позволяет обнаружить сертификаты клиента. Это можно исправить, заменив localhost на local.playwright.

  • extraHTTPHeaders Object<string, string> (необязательно)

    Объект с дополнительными HTTP-заголовками, которые будут отправляться с каждым запросом. По умолчанию не задан.

  • failOnStatusCode boolean (необязательно)

    Определяет, следует ли вызывать исключение для кодов ответа, отличных от 2xx и 3xx. По умолчанию объект ответа возвращается для всех кодов состояния.

  • httpCredentials Object | Array<Object> (необязательно)

    • username string

    • password string

    • origin string (необязательно)

      Ограничивает отправку учетных данных HTTP для определенного источника (scheme://host:port).

    • send "unauthorized" | "always" (необязательно)

      Этот параметр применяется только к запросам, отправляемым соответствующим APIRequestContext, и не влияет на запросы, отправляемые браузером. 'always' — заголовок Authorization с учетными данными базовой аутентификации будет отправляться с каждым запросом API. 'unauthorized — учетные данные отправляются только после получения ответа 401 (Unauthorized) с заголовком WWW-Authenticate. Значение по умолчанию — 'unauthorized'.

    Учетные данные для аутентификации HTTP. Если источник не указан, имя пользователя и пароль отправляются на любые серверы при получении ответов о неавторизованном доступе.

    Передайте массив, чтобы использовать разные учетные данные для разных источников. Используется первая запись, соответствующая источнику запроса; записи без указанного источника соответствуют любому запросу.

  • ignoreHTTPSErrors boolean (необязательно)

    Определяет, следует ли игнорировать ошибки HTTPS при отправке сетевых запросов. По умолчанию — false.

  • maxRedirects number (необязательно)

    Максимальное количество перенаправлений запроса, которые будут выполняться автоматически. Если это количество превышено, будет вызвана ошибка. По умолчанию — 20. Передайте 0, чтобы не выполнять перенаправления. Это значение можно переопределить отдельно для каждого запроса.

  • proxy Object (необязательно)

    • server string

      Прокси-сервер, используемый для всех запросов. Поддерживаются прокси HTTP и SOCKS, например http://myproxy.com:3128 или socks5://myproxy.com:3128. Сокращенная форма myproxy.com:3128 рассматривается как прокси HTTP.

    • bypass string (необязательно)

      Необязательный список разделенных запятыми доменов, для которых не используется прокси, например ".com, chromium.org, .domain.com".

    • username string (необязательно)

      Необязательное имя пользователя, используемое, если прокси HTTP требует аутентификации.

    • password string (необязательно)

      Необязательный пароль, используемый, если прокси HTTP требует аутентификации.

    Параметры сетевого прокси.

  • storageState string | Object (необязательно)

    • cookies Array<Object>

      • name string

      • value string

      • domain string

      • path string

      • expires number

        Время Unix в секундах.

      • httpOnly boolean

      • secure boolean

      • sameSite "Strict" | "Lax" | "None"

    • origins Array<Object>

      • origin string

      • localStorage Array<Object>

        • name string

        • value string

    Заполняет контекст указанным состоянием хранилища. Этот параметр можно использовать для инициализации контекста сведениями о входе в систему, полученными с помощью browserContext.storageState() или apiRequestContext.storageState(). Укажите путь к файлу с сохраненным состоянием хранилища или значение, возвращаемое одним из методов browserContext.storageState() или apiRequestContext.storageState().

  • timeout number (необязательно)

    Максимальное время ожидания ответа в миллисекундах. По умолчанию — 30000 (30 секунд). Передайте 0, чтобы отключить тайм-аут.

  • userAgent string (необязательно)

    Пользовательский агент, используемый в этом контексте.

Возвращает

• Promise<APIRequestContext>