Request():setHeader()

HTTP リクエストの新しいヘッダーを設定します。このメソッドを使用すると、リクエストを送信する前にカスタム HTTP ヘッダーを追加できます。

シグネチャ

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

パラメータ

パラメータ	型	説明
key	string	ヘッダー名
value	string	ヘッダーの値

戻り値

Request - メソッドチェーン用に Request オブジェクトを返します

説明

setHeader() メソッドは、リクエストにカスタム HTTP ヘッダーを追加します。ヘッダーは、コンテンツタイプ、認証、ユーザーエージェントなど、リクエストに関する追加情報を提供するメタデータです。このメソッドは複数回呼び出すことで複数のヘッダーを追加できます。

例

認証ヘッダーの設定

-- API 認証用の Bearer トークンを追加
local response = Request("https://api.example.com/data")
    :setHeader("Authorization", "Bearer your-token-here")
    :get()

コンテンツタイプの設定

-- POST リクエスト用の JSON コンテンツタイプを設定
local response = Request("https://api.example.com/users")
    :setHeader("Content-Type", "application/json")
    :setParameter("name", "John Doe")
    :setParameter("email", "john@example.com")
    :post()

複数のヘッダー

-- リクエストに複数のヘッダーを設定
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()

カスタムヘッダー

-- アプリケーション固有のカスタムヘッダーを追加
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()

フォームデータのヘッダー

-- フォームデータ送信用のヘッダーを設定
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 などの特定のヘッダーは通常、自動的に計算されます
• 認証ヘッダーには注意し、機密情報を公開しないようにしてください
• 同じヘッダー名を複数回設定すると、ヘッダーを上書きできます