Header parameters API – запитів, що слугують для передачі метаданих та керуючої інформації. У REST API заголовки можуть включати різні параметри (див. Understanding REST Headers and Parameters або Заголовки HTTP).
Типові Headers:
Key | Value | Mandatory ( |
|---|
M/O) | Description |
|---|
Example |
|---|
Content-Type | application/json | M | Вказує формат даних у тілі запиту/відповіді | Content-Type: application/json |
Authorization
M
...
Authorization | Bearer {{access_token}} | M | Вказує токен авторизації для доступу | Authorization: Bearer Token |
Accept | application/json | O | Вказує, який формат відповіді очікується | Accept: application/json |
User-Agent | {{client_info}} | O | Інформація про клієнтське ПЗ | User-Agent: MyApp/1.0 |
Host | {{host_name}} | M | Ім'я хоста для ідентифікації сервера | Host: api.example.com |
Content-Length | {{content_length}} | O | Довжина тіла запиту в байтах | Content-Length: 348 |
Cache-Control | no-cache | O | Вказує правила кешування | Cache-Control: no-cache |
Accept-Encoding | gzip, deflate | O | Способи стиснення, які підтримуються | Accept-Encoding: gzip, deflate |
Connection | keep-alive | O | Визначає тип з'єднання | Connection: keep-alive |
...
Не-типові Headers:
Key | Value | Mandatory ( |
|---|
Description(опис призначення або використання Header)
Example(повний приклад ключ:значення)
Content-Type
application/json
Content-Type:application/json
M/O) | Description | Example | ||
|---|---|---|---|---|
X-Custom-Header-ProjectA | {{custom_value}} | O | Спеціальний заголовок для ProjectA | X-Custom-Header-ProjectA: custom_value |
X-Token-Auth-ProjectB | Token {{token_value}} | M | Токен автентифікації для ProjectB | X-Token-Auth-ProjectB: Token 12345abc |
X-Special-Flag-ProjectC | enabled | O | Увімкнення особливого режиму в ProjectC | X-Special-Flag-ProjectC: enabled |
X-Feature-Flag-ExperimentD | experiment_active | O | Флаг для експериментального функціоналу | X-Feature-Flag-ExperimentD: experiment_active |
Custom-Cache-Strategy-ProjectE | custom_strategy | O | Стратегія кешування для ProjectE | Custom-Cache-Strategy-ProjectE: custom_strategy |
...
Key: Назва заголовка.
Value: Значення, яке потрібно використовувати.
Mandatory (M/O): Позначка обов'язковості заголовка — M (Mandatory, обов’язковий) або O (Optional, необов’язковий).
Description: Короткий опис призначення заголовка.
Example: Повний приклад заголовка із значенням.