Перейти к основному содержимому

APIRequestContext

Этот API используется для тестирования веб-API. Вы можете использовать его для вызова API-эндпоинтов, настройки микросервисов, подготовки окружения или сервиса для вашего e2e теста.

Каждый контекст браузера Playwright связан с экземпляром APIRequestContext, который разделяет хранилище куки с контекстом браузера и может быть доступен через browserContext.request или page.request. Также возможно вручную создать новый экземпляр APIRequestContext, вызвав apiRequest.newContext().

Управление куки

APIRequestContext, возвращаемый browserContext.request и page.request, разделяет хранилище куки с соответствующим BrowserContext. Каждый API-запрос будет иметь заголовок Cookie, заполненный значениями из контекста браузера. Если ответ API содержит заголовок Set-Cookie, он автоматически обновит куки BrowserContext, и запросы, сделанные со страницы, будут их учитывать. Это означает, что если вы войдете в систему с помощью этого API, ваш e2e тест будет также авторизован и наоборот.

Если вы хотите, чтобы API-запросы не мешали куки браузера, вам следует создать новый APIRequestContext, вызвав apiRequest.newContext(). Такой объект APIRequestContext будет иметь свое собственное изолированное хранилище куки.

Методы​

delete​

Добавлено в: v1.16 apiRequestContext.delete

Отправляет HTTP(S) DELETE запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать за перенаправлениями.

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

await apiRequestContext.delete(url);
await apiRequestContext.delete(url, options);

Аргументы

  • url string#

    Целевой URL.

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

    • data string | Buffer | Serializable (необязательно) Добавлено в: v1.17#

      Позволяет установить данные поста запроса. Если параметр data является объектом, он будет сериализован в json-строку, и заголовок content-type будет установлен в application/json, если не установлен явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не установлен явно.

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

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

    • form Object<string, string | number | boolean> | FormData (необязательно) Добавлено в: v1.17#

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не предоставлен явно.

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

      Позволяет установить HTTP-заголовки. Эти заголовки будут применяться к запрашиваемому запросу, а также ко всем перенаправлениям, инициированным им.

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

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

    • maxRedirects number (необязательно) Добавлено в: v1.26#

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

    • maxRetries number (необязательно) Добавлено в: v1.46#

      Максимальное количество раз, которое следует повторить сетевые ошибки. В настоящее время повторяется только ошибка ECONNRESET. Не повторяет на основе кодов ответа HTTP. Ошибка будет выброшена, если лимит превышен. По умолчанию 0 - без повторов.

    • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (необязательно) Добавлено в: v1.17#

      • name string

        Имя файла

      • mimeType string

        Тип файла

      • buffer Buffer

        Содержимое файла

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не предоставлен явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, mime-тип и его содержимое.

    • params Object<string, string | number | boolean> | URLSearchParams | string (необязательно)#

      Параметры запроса, которые будут отправлены с URL.

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

      Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

dispose​

Добавлено в: v1.16 apiRequestContext.dispose

Все ответы, возвращаемые apiRequestContext.get() и аналогичными методами, хранятся в памяти, чтобы вы могли позже вызвать apiResponse.body(). Этот метод отбрасывает все свои ресурсы, вызов любого метода на утилизированном APIRequestContext вызовет исключение.

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

await apiRequestContext.dispose();
await apiRequestContext.dispose(options);

Аргументы

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

    • reason string (необязательно) Добавлено в: v1.45#

      Причина, которая будет сообщена о действиях, прерванных утилизацией контекста.

Возвращает

fetch​

Добавлено в: v1.16 apiRequestContext.fetch

Отправляет HTTP(S) запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать за перенаправлениями.

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

JSON-объекты могут быть переданы напрямую в запрос:

await request.fetch('https://example.com/api/createBook', {
  method: 'post',
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Общий способ отправки файла(ов) в теле запроса - это загрузка их в качестве полей формы с кодировкой multipart/form-data, указав параметр multipart:

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Отправить два поля файла с одним и тем же именем.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.fetch('https://example.com/api/uploadForm', {
  multipart: form
});

Аргументы

  • urlOrRequest string | Request#

    Целевой URL или запрос, из которого будут получены все параметры.

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

    • data string | Buffer | Serializable (необязательно)#

      Позволяет установить данные поста запроса. Если параметр data является объектом, он будет сериализован в json-строку, и заголовок content-type будет установлен в application/json, если не установлен явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не установлен явно.

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

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

    • form Object<string, string | number | boolean> | FormData (необязательно)#

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не предоставлен явно.

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

      Позволяет установить HTTP-заголовки. Эти заголовки будут применяться к запрашиваемому запросу, а также ко всем перенаправлениям, инициированным им.

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

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

    • maxRedirects number (необязательно) Добавлено в: v1.26#

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

    • maxRetries number (необязательно) Добавлено в: v1.46#

      Максимальное количество раз, которое следует повторить сетевые ошибки. В настоящее время повторяется только ошибка ECONNRESET. Не повторяет на основе кодов ответа HTTP. Ошибка будет выброшена, если лимит превышен. По умолчанию 0 - без повторов.

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

      Если установлен, изменяет метод запроса (например, PUT или POST). Если не указано, используется метод GET.

    • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (необязательно)#

      • name string

        Имя файла

      • mimeType string

        Тип файла

      • buffer Buffer

        Содержимое файла

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не предоставлен явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, mime-тип и его содержимое.

    • params Object<string, string | number | boolean> | URLSearchParams | string (необязательно)#

      Параметры запроса, которые будут отправлены с URL.

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

      Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

get​

Добавлено в: v1.16 apiRequestContext.get

Отправляет HTTP(S) GET запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать за перенаправлениями.

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

Параметры запроса могут быть настроены с помощью параметра params, они будут сериализованы в параметры поиска URL:

// Передача параметров в виде объекта
await request.get('https://example.com/api/getText', {
  params: {
    'isbn': '1234',
    'page': 23,
  }
});

// Передача параметров в виде URLSearchParams
const searchParams = new URLSearchParams();
searchParams.set('isbn', '1234');
searchParams.append('page', 23);
searchParams.append('page', 24);
await request.get('https://example.com/api/getText', { params: searchParams });

// Передача параметров в виде строки
const queryString = 'isbn=1234&page=23&page=24';
await request.get('https://example.com/api/getText', { params: queryString });

Аргументы

  • url string#

    Целевой URL.

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

    • data string | Buffer | Serializable (необязательно) Добавлено в: v1.26#

      Позволяет установить данные поста запроса. Если параметр data является объектом, он будет сериализован в json-строку, и заголовок content-type будет установлен в application/json, если не установлен явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не установлен явно.

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

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

    • form Object<string, string | number | boolean> | FormData (необязательно) Добавлено в: v1.26#

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не предоставлен явно.

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

      Позволяет установить HTTP-заголовки. Эти заголовки будут применяться к запрашиваемому запросу, а также ко всем перенаправлениям, инициированным им.

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

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

    • maxRedirects number (необязательно) Добавлено в: v1.26#

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

    • maxRetries number (необязательно) Добавлено в: v1.46#

      Максимальное количество раз, которое следует повторить сетевые ошибки. В настоящее время повторяется только ошибка ECONNRESET. Не повторяет на основе кодов ответа HTTP. Ошибка будет выброшена, если лимит превышен. По умолчанию 0 - без повторов.

    • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (необязательно) Добавлено в: v1.26#

      • name string

        Имя файла

      • mimeType string

        Тип файла

      • buffer Buffer

        Содержимое файла

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не предоставлен явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, mime-тип и его содержимое.

    • params Object<string, string | number | boolean> | URLSearchParams | string (необязательно)#

      Параметры запроса, которые будут отправлены с URL.

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

      Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

head​

Добавлено в: v1.16 apiRequestContext.head

Отправляет HTTP(S) HEAD запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать за перенаправлениями.

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

await apiRequestContext.head(url);
await apiRequestContext.head(url, options);

Аргументы

  • url string#

    Целевой URL.

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

    • data string | Buffer | Serializable (необязательно) Добавлено в: v1.26#

      Позволяет установить данные поста запроса. Если параметр data является объектом, он будет сериализован в json-строку, и заголовок content-type будет установлен в application/json, если не установлен явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не установлен явно.

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

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

    • form Object<string, string | number | boolean> | FormData (необязательно) Добавлено в: v1.26#

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не предоставлен явно.

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

      Позволяет установить HTTP-заголовки. Эти заголовки будут применяться к запрашиваемому запросу, а также ко всем перенаправлениям, инициированным им.

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

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

    • maxRedirects number (необязательно) Добавлено в: v1.26#

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

    • maxRetries number (необязательно) Добавлено в: v1.46#

      Максимальное количество раз, которое следует повторить сетевые ошибки. В настоящее время повторяется только ошибка ECONNRESET. Не повторяет на основе кодов ответа HTTP. Ошибка будет выброшена, если лимит превышен. По умолчанию 0 - без повторов.

    • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (необязательно) Добавлено в: v1.26#

      • name string

        Имя файла

      • mimeType string

        Тип файла

      • buffer Buffer

        Содержимое файла

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не предоставлен явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, mime-тип и его содержимое.

    • params Object<string, string | number | boolean> | URLSearchParams | string (необязательно)#

      Параметры запроса, которые будут отправлены с URL.

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

      Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

patch​

Добавлено в: v1.16 apiRequestContext.patch

Отправляет HTTP(S) PATCH запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать за перенаправлениями.

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

await apiRequestContext.patch(url);
await apiRequestContext.patch(url, options);

Аргументы

  • url string#

    Целевой URL.

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

    • data string | Buffer | Serializable (необязательно)#

      Позволяет установить данные поста запроса. Если параметр data является объектом, он будет сериализован в json-строку, и заголовок content-type будет установлен в application/json, если не установлен явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не установлен явно.

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

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

    • form Object<string, string | number | boolean> | FormData (необязательно)#

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не предоставлен явно.

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

      Позволяет установить HTTP-заголовки. Эти заголовки будут применяться к запрашиваемому запросу, а также ко всем перенаправлениям, инициированным им.

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

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

    • maxRedirects number (необязательно) Добавлено в: v1.26#

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

    • maxRetries number (необязательно) Добавлено в: v1.46#

      Максимальное количество раз, которое следует повторить сетевые ошибки. В настоящее время повторяется только ошибка ECONNRESET. Не повторяет на основе кодов ответа HTTP. Ошибка будет выброшена, если лимит превышен. По умолчанию 0 - без повторов.

    • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (необязательно)#

      • name string

        Имя файла

      • mimeType string

        Тип файла

      • buffer Buffer

        Содержимое файла

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не предоставлен явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, mime-тип и его содержимое.

    • params Object<string, string | number | boolean> | URLSearchParams | string (необязательно)#

      Параметры запроса, которые будут отправлены с URL.

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

      Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

post​

Добавлено в: v1.16 apiRequestContext.post

Отправляет HTTP(S) POST запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать за перенаправлениями.

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

JSON-объекты могут быть переданы напрямую в запрос:

await request.post('https://example.com/api/createBook', {
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Чтобы отправить данные формы на сервер, используйте параметр form. Его значение будет закодировано в тело запроса с кодировкой application/x-www-form-urlencoded (см. ниже, как использовать кодировку формы multipart/form-data для отправки файлов):

await request.post('https://example.com/api/findBook', {
  form: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Общий способ отправки файла(ов) в теле запроса - это загрузка их в качестве полей формы с кодировкой multipart/form-data. Используйте FormData, чтобы создать тело запроса и передать его в запрос в качестве параметра multipart:

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Отправить два поля файла с одним и тем же именем.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.post('https://example.com/api/uploadForm', {
  multipart: form
});

Аргументы

  • url string#

    Целевой URL.

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

    • data string | Buffer | Serializable (необязательно)#

      Позволяет установить данные поста запроса. Если параметр data является объектом, он будет сериализован в json-строку, и заголовок content-type будет установлен в application/json, если не установлен явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не установлен явно.

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

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

    • form Object<string, string | number | boolean> | FormData (необязательно)#

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не предоставлен явно.

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

      Позволяет установить HTTP-заголовки. Эти заголовки будут применяться к запрашиваемому запросу, а также ко всем перенаправлениям, инициированным им.

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

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

    • maxRedirects number (необязательно) Добавлено в: v1.26#

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

    • maxRetries number (необязательно) Добавлено в: v1.46#

      Максимальное количество раз, которое следует повторить сетевые ошибки. В настоящее время повторяется только ошибка ECONNRESET. Не повторяет на основе кодов ответа HTTP. Ошибка будет выброшена, если лимит превышен. По умолчанию 0 - без повторов.

    • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (необязательно)#

      • name string

        Имя файла

      • mimeType string

        Тип файла

      • buffer Buffer

        Содержимое файла

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не предоставлен явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, mime-тип и его содержимое.

    • params Object<string, string | number | boolean> | URLSearchParams | string (необязательно)#

      Параметры запроса, которые будут отправлены с URL.

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

      Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

put​

Добавлено в: v1.16 apiRequestContext.put

Отправляет HTTP(S) PUT запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать за перенаправлениями.

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

await apiRequestContext.put(url);
await apiRequestContext.put(url, options);

Аргументы

  • url string#

    Целевой URL.

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

    • data string | Buffer | Serializable (необязательно)#

      Позволяет установить данные поста запроса. Если параметр data является объектом, он будет сериализован в json-строку, и заголовок content-type будет установлен в application/json, если не установлен явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не установлен явно.

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

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

    • form Object<string, string | number | boolean> | FormData (необязательно)#

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не предоставлен явно.

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

      Позволяет установить HTTP-заголовки. Эти заголовки будут применяться к запрашиваемому запросу, а также ко всем перенаправлениям, инициированным им.

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

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

    • maxRedirects number (необязательно) Добавлено в: v1.26#

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

    • maxRetries number (необязательно) Добавлено в: v1.46#

      Максимальное количество раз, которое следует повторить сетевые ошибки. В настоящее время повторяется только ошибка ECONNRESET. Не повторяет на основе кодов ответа HTTP. Ошибка будет выброшена, если лимит превышен. По умолчанию 0 - без повторов.

    • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (необязательно)#

      • name string

        Имя файла

      • mimeType string

        Тип файла

      • buffer Buffer

        Содержимое файла

      Предоставляет объект, который будет сериализован как html-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не предоставлен явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, mime-тип и его содержимое.

    • params Object<string, string | number | boolean> | URLSearchParams | string (необязательно)#

      Параметры запроса, которые будут отправлены с URL.

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

      Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

storageState​

Добавлено в: v1.16 apiRequestContext.storageState

Возвращает состояние хранилища для этого контекста запроса, содержит текущие куки и снимок локального хранилища, если он был передан в конструктор.

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

await apiRequestContext.storageState();
await apiRequestContext.storageState(options);

Аргументы

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

    • indexedDB boolean (необязательно) Добавлено в: v1.51#

      Установите в true, чтобы включить IndexedDB в снимок состояния хранилища.

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

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

Возвращает