Zum Hauptinhalt springen

Request():setHeader()

Setzt einen neuen Header für HTTP-Anfragen. Diese Methode ermöglicht es Ihnen, Ihren Anfragen vor dem Senden benutzerdefinierte HTTP-Header hinzuzufügen.

Signatur

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

Parameter

ParametersTypeDescription
keystringDer Header-Name
valuestringDer Header-Wert

Rückgabe

Request - Gibt das Request-Objekt für Methodenverkettung zurück

Beschreibung

Die Methode setHeader() fügt der Anfrage einen benutzerdefinierten HTTP-Header hinzu. Header sind Metadaten, die zusätzliche Informationen über die Anfrage liefern, wie beispielsweise Inhaltstyp, Autorisierung oder User-Agent. Sie können diese Methode mehrfach aufrufen, um mehrere Header hinzuzufügen.

Beispiele

Authorization-Header setzen

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

Inhaltstyp festlegen

-- 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()

Mehrere Header

-- 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()

Benutzerdefinierte Header

-- 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()

Header für Formulardaten

-- 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()

Gängige HTTP-Header

Header NameTypical UsageExample
AuthorizationAuthentifizierungs-Token"Bearer token123"
Content-TypeFormat des Anfragekörpers"application/json"
AcceptBevorzugtes Antwortformat"application/json"
User-AgentClient-Identifikation"MyApp/1.0"
X-API-KeyAPI-Authentifizierung"your-api-key"
Content-LengthGröße des Anfragekörpers (meist automatisch gesetzt)"256"

Hinweise

  • Header Groß-/Kleinschreibung wird nicht beachtet, es ist jedoch üblich, Header-Case zu verwenden (z. B. Content-Type)
  • Die Methode gibt das Request-Objekt zurück und ermöglicht somit Methodenverkettung
  • Einige Header werden möglicherweise automatisch vom HTTP-Client gesetzt
  • Bestimmte Header wie Content-Length werden in der Regel automatisch berechnet
  • Seien Sie vorsichtig mit Authentifizierungs-Headern und offenbaren Sie keine sensiblen Informationen
  • Sie können Header überschreiben, indem Sie denselben Header-Namen mehrfach setzen