Request():setHeader()
Thiết lập một header mới cho yêu cầu HTTP. Phương thức này cho phép bạn thêm các HTTP header tùy chỉnh vào yêu cầu trước khi gửi.
Khai báo
setHeader(key: string, value: string): Request
Tham số
| Tham số | Kiểu | Mô tả |
|---|---|---|
| key | string | Tên của header |
| value | string | Giá trị của header |
Trả về
Request - Trả về đối tượng Request để có thể gọi phương thức liên tiếp
Mô tả
Phương thức setHeader() thêm một HTTP header tùy chỉnh vào yêu cầu. Header là siêu dữ liệu (metadata) cung cấp thêm thông tin về yêu cầu, chẳng hạn như kiểu nội dung, xác thực hoặc user agent. Bạn có thể gọi phương thức này nhiều lần để thêm nhiều header.
Ví dụ
Thiết lập Header xác thực
-- Thêm Bearer token để xác thực API
local response = Request("https://api.example.com/data")
:setHeader("Authorization", "Bearer your-token-here")
:get()
Thiết lập Content Type
-- Thiết lập kiểu nội dung JSON cho yêu cầu POST
local response = Request("https://api.example.com/users")
:setHeader("Content-Type", "application/json")
:setParameter("name", "John Doe")
:setParameter("email", "john@example.com")
:post()
Nhiều Headers
-- Thiết lập nhiều header cho một yêu cầu
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()
Headers tùy chỉnh
-- Thêm các header tùy chỉnh theo từng ứng dụng
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()
Headers cho dữ liệu biểu mẫu
-- Thiết lập header cho việc gửi dữ liệu biểu mẫu
local response = Request("https://example.com/login")
:setHeader("Content-Type", "application/x-www-form-urlencoded")
:setParameter("username", "user")
:setParameter("password", "pass")
:post()
Các HTTP Header phổ biến
| Tên Header | Cách dùng thông thường | Ví dụ |
|---|---|---|
Authorization | Token xác thực | "Bearer token123" |
Content-Type | Định dạng phần thân yêu cầu | "application/json" |
Accept | Tùy chọn định dạng phản hồi | "application/json" |
User-Agent | Nhận diện client | "MyApp/1.0" |
X-API-Key | Xác thực API | "your-api-key" |
Content-Length | Kích thước phần thân yêu cầu (thường tự động) | "256" |
Lưu ý
- Header không phân biệt chữ hoa chữ thường, nhưng theo thông lệ nên dùng Header-Case (ví dụ:
Content-Type) - Phương thức trả về đối tượng Request, cho phép gọi phương thức liên tiếp
- Một số header có thể được thiết lập tự động bởi HTTP client
- Một số header nhất định như
Content-Lengththường được tính toán tự động - Hãy cẩn thận với các header xác thực và không để lộ thông tin nhạy cảm
- Bạn có thể ghi đè header bằng cách đặt cùng một tên header nhiều lần