Request():setHeader()

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

Сигнатура

setHeader(key: string, value: string): Request

Параметры

Параметры	Тип	Описание
key	string	Имя заголовка
value	string	Значение заголовка

Возвращаемое значение

Request — возвращает объект Request для цепочки вызовов методов

Описание

Метод setHeader() добавляет пользовательский HTTP-заголовок к запросу. Заголовки — это метаданные, предоставляющие дополнительную информацию о запросе, такую как тип содержимого, авторизация или пользовательский агент. Вы можете вызывать этот метод несколько раз, чтобы добавить несколько заголовков.

Примеры

Установка заголовка авторизации

-- Add Bearer token for API authentication
local response = Request("https://api.example.com/data")
    :setHeader("Authorization", "Bearer your-token-here")
    :get()

Установка типа содержимого

-- Set JSON content type for POST requests
local response = Request("https://api.example.com/users")
    :setHeader("Content-Type", "application/json")
    :setParameter("name", "John Doe")
    :setParameter("email", "john@example.com")
    :post()

Несколько заголовков

-- Set multiple headers for a request
local response = Request("https://api.example.com/protected")
    :setHeader("Authorization", "Bearer token123")
    :setHeader("Content-Type", "application/json")
    :setHeader("Accept", "application/json")
    :setHeader("User-Agent", "MyApp/1.0")
    :get()

Пользовательские заголовки

-- Add custom application-specific headers
local response = Request("https://api.example.com/process")
    :setHeader("X-API-Key", "your-api-key")
    :setHeader("X-Request-ID", "unique-request-identifier")
    :setHeader("X-Client-Version", "2.1.0")
    :post()

Заголовки данных формы

-- Set headers for form data submission
local response = Request("https://example.com/login")
    :setHeader("Content-Type", "application/x-www-form-urlencoded")
    :setParameter("username", "user")
    :setParameter("password", "pass")
    :post()

Распространённые HTTP-заголовки

Имя заголовка	Типичное использование	Пример
Authorization	Токены аутентификации	"Bearer token123"
Content-Type	Формат тела запроса	"application/json"
Accept	Предпочитаемый формат ответа	"application/json"
User-Agent	Идентификация клиента	"MyApp/1.0"
X-API-Key	Аутентификация API	"your-api-key"
Content-Length	Размер тела запроса (обычно устанавливается автоматически)	"256"

Примечания

• Заголовки нечувствительны к регистру, но принято использовать Header-Case (например, Content-Type)
• Метод возвращает объект Request, что позволяет создавать цепочки вызовов методов
• Некоторые заголовки могут быть автоматически установлены HTTP-клиентом
• Определённые заголовки, такие как Content-Length, обычно вычисляются автоматически
• Будьте осторожны с заголовками аутентификации и не раскрывайте конфиденциальную информацию
• Вы можете переопределять заголовки, устанавливая одно и то же имя заголовка несколько раз