RequesttimeoutЗадаёт максимальное время выполнения запроса.
Сигнатура: timeout(timeout: int) -> Request
Аргументы: timeout — допустимое время запроса в секундах.
Пример использования:
$response = http.request("https://some.url", "GET")
.timeout(300)
.send();
urlОпределяет URL для HTTP-запроса.
Сигнатура: url(url: string) -> Request
Аргументы: url — строка, представляющая адрес запроса.
Пример использования:
$response = http.request()
.url("http://some.url?p1=v1&p2=v2")
.method("GET")
.send();
methodОпределяет HTTP-метод (например, GET, POST, PUT).
Сигнатура: method(method: string) -> Request
Аргументы: method — строка с названием HTTP-метода.
Пример использования:
$response = http.request()
.url("http://some.url")
.method("POST")
.send();
bodyОпределяет содержимое тела HTTP-запроса.
Сигнатура: body(body: any) -> Request
Аргументы: body — содержимое запроса.
Пример использования:
$response = http.request()
.url("http://some.url")
.method("PUT")
.body("example body content")
.send();
headerДобавляет HTTP-заголовок к запросу.
Сигнатура: header(header: string, value: string) -> Request
Аргументы:
header — название заголовка.value — значение заголовка.Пример использования:
$response = http.request()
.url("http://some.url")
.method("POST")
.header("Content-Type", "application/json")
.send();
headersУстанавливает набор HTTP-заголовков.
Сигнатура: headers(headers: Map) -> Request
Аргументы: headers — объект, где ключи — имена заголовков, а значения — их значения.
Пример использования:
$response = http.request()
.url("http://some.url")
.method("PUT")
.headers({"Content-Type": "application/json", "Authorization": "Bearer token"})
.send();
fileДобавляет файл для отправки в запросе.
Сигнатура:
file(fileId: string, name: string = "") -> Request
Аргументы:
fileId — идентификатор загруженного файла.name — название параметра для отправки файла.Пример использования:
$response = http.request()
.url("http://some.url")
.method("POST")
.file($fileId, "uploaded_file")
.send();
sendОтправляет запрос и возвращает объект ответа.
Сигнатура: send() -> Response
Пример использования:
$response = http.request()
.url("http://some.url")
.method("GET")
.send();
ResponsestatusCodeВозвращает код состояния HTTP-ответа.
Пример использования:
$code = $response.statusCode;
bodyВозвращает содержимое ответа.
Пример использования:
$content = $response.body;
headersВозвращает все заголовки ответа в виде объекта.
Пример использования:
$headers = $response.headers;
isErrorОпределяет наличие ошибки в ответе. Возвращает true, если код состояния >= 400 или есть поле error.
Пример использования:
$hasError = $response.isError();
isSuccessfulВозвращает true, если код состояния < 400 и поле error отсутствует.
Пример использования:
$isSuccessful = $response.isSuccessful();
hasHeaderВозвращает true, если указанный заголовок присутствует в ответе.
Сигнатура: hasHeader(header: string) -> bool
Пример использования:
$hasContentType = $response.hasHeader("Content-Type");
headerВозвращает значение заголовка с указанным именем или пустую строку, если такого заголовка нет.
Сигнатура: header(header: string) -> string
Пример использования:
$contentType = $response.header("Content-Type");
toFileСохраняет тело ответа в файл и возвращает его идентификатор загруженного файла.
Пример использования:
$fileId = $response.toFile();