Request():setHeader()
Définir un nouvel en-tête pour les requêtes HTTP. Cette méthode vous permet d'ajouter des en-têtes HTTP personnalisés à votre requête avant de l'envoyer.
Signature
setHeader(key: string, value: string): Request
Paramètres
Paramètres | Type | Description |
---|---|---|
key | string | Le nom de l'en-tête |
value | string | La valeur de l'en-tête |
Renvoie
Request
- Renvoie l'objet Request pour le chaînage de méthodes
Description
La méthode setHeader()
ajoute un en-tête HTTP personnalisé à la requête. Les en-têtes sont des métadonnées qui fournissent des informations supplémentaires sur la requête, comme le type de contenu, l'autorisation ou l'agent utilisateur. Vous pouvez appeler cette méthode plusieurs fois pour ajouter plusieurs en-têtes.
Exemples
Définir un en-tête d'autorisation
-- Ajouter un token Bearer pour l'authentification API
local response = Request("https://api.example.com/data")
:setHeader("Authorization", "Bearer votre-token-ici")
:get()
Définir le type de contenu
-- Définir le type de contenu JSON pour les requêtes POST
local response = Request("https://api.example.com/users")
:setHeader("Content-Type", "application/json")
:setParameter("name", "John Doe")
:setParameter("email", "john@example.com")
:post()
En-têtes multiples
-- Définir plusieurs en-têtes pour une requête
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()
En-têtes personnalisés
-- Ajouter des en-têtes spécifiques à l'application
local response = Request("https://api.example.com/process")
:setHeader("X-API-Key", "votre-clé-api")
:setHeader("X-Request-ID", "identifiant-de-requête-unique")
:setHeader("X-Client-Version", "2.1.0")
:post()
En-têtes de données de formulaire
-- Définir des en-têtes pour la soumission de données de formulaire
local response = Request("https://example.com/login")
:setHeader("Content-Type", "application/x-www-form-urlencoded")
:setParameter("username", "user")
:setParameter("password", "pass")
:post()
En-têtes HTTP courants
Nom de l'en-tête | Utilisation typique | Exemple |
---|---|---|
Authorization | Tokens d'authentification | "Bearer token123" |
Content-Type | Format du corps de la requête | "application/json" |
Accept | Préférence de format de réponse | "application/json" |
User-Agent | Identification du client | "MyApp/1.0" |
X-API-Key | Authentification API | "votre-clé-api" |
Content-Length | Taille du corps de la requête (généralement défini automatiquement) | "256" |
Notes
- Les en-têtes ne sont pas sensibles à la casse, mais il est conventionnel d'utiliser Header-Case (par exemple,
Content-Type
) - La méthode renvoie l'objet Request, permettant le chaînage de méthodes
- Certains en-têtes peuvent être définis automatiquement par le client HTTP
- Certains en-têtes comme
Content-Length
sont généralement calculés automatiquement - Soyez prudent avec les en-têtes d'authentification et n'exposez pas d'informations sensibles
- Vous pouvez remplacer les en-têtes en définissant le même nom d'en-tête plusieurs fois