Những HTTP header nào quan trọng nhất trong request và response của API?

Header chứa metadata của message, để body chỉ tập trung vào dữ liệu. Đây là những header mà người thiết kế API dùng hằng ngày.

Request header

• Content-Type: định dạng của body bạn gửi, như application/json.
• Accept: các định dạng client đọc được.
• Authorization: thông tin xác thực, ví dụ Bearer <token>.
• Idempotency-Key: cho phép client retry POST an toàn.
• If-None-Match và If-Match: đọc và ghi có điều kiện với ETag.

Response header

• Content-Type: định dạng của response.
• Location: URL của resource mới sau 201, hoặc của job sau 202.
• Cache-Control và ETag: caching và validation.
• Retry-After và RateLimit-*: hướng dẫn về throttling.
• WWW-Authenticate: gửi cùng 401 để nói cách xác thực.
• Link: link phân trang.

Để debug, trả về request id như X-Request-Id, hoặc dùng header traceparent của W3C để bộ phận hỗ trợ tìm được lời gọi trong log.

Header dùng cho metadata. Dữ liệu client đang làm việc thì thuộc về body.