APIRequest

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

Методы​

newContext​

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

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

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

Аргументы

• options Объект (необязательно)

  • baseURL строка (необязательно)

    Методы, такие как 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 Массив<Объект> (необязательно)

    • origin строка

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

    • certPath строка (необязательно)

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

    • cert Буфер (необязательно)

      Прямое значение сертификата в формате PEM.

    • keyPath строка (необязательно)

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

    • key Буфер (необязательно)

      Прямое значение закрытого ключа в формате PEM.

    • pfxPath строка (необязательно)

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

    • pfx Буфер (необязательно)

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

    • passphrase строка (необязательно)

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

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

    Детали

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

    замечание

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

  • extraHTTPHeaders Объект<строка, строка> (необязательно)

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

  • httpCredentials Объект (необязательно)

    • username строка

    • password строка

    • origin строка (необязательно)

      Ограничить отправку http-креденциалов на определенный источник (схема://хост:порт).

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

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

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

  • ignoreHTTPSErrors логическое значение (необязательно)

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

  • proxy Объект (необязательно)

    • server строка

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

    • bypass строка (необязательно)

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

    • username строка (необязательно)

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

    • password строка (необязательно)

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

    Настройки сетевого прокси.

• • storageState строка | объект (необязательно)

    • cookies массив<объект>

      • name строка

      • value строка

      • domain строка

      • path строка

      • expires число

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

      • httpOnly логическое значение

      • secure логическое значение

      • sameSite «Строгое» | «Свободное» | «Отсутствует»

    • origins массив<объект>

      • origin строка

      • localStorage массив<объект>

        • name строка

        • value строка

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

  • timeout число (необязательно)

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

  • userAgent строка (необязательно)

    Конкретный пользовательский агент для использования в этом контексте.

Возвращает

• Обещание<APIRequestContext>