大网数据广告活动
Web 标准与前端开发

Prefer header

· 52CE 我爱测

The HTTP **`Prefer`** header allows clients to indicate preferences for specific server behaviors during request processing.

The HTTP Prefer header allows clients to indicate preferences for specific server behaviors during request processing.

[!NOTE] Browsers have no handling for the Prefer and Preference-Applied headers: they are used in custom, implementation-specific clients. Ensure both client and server support this header before relying on it in production.

Servers should silently ignore preferences that they do not support, as though the header were not present.

<table class="properties"> <tbody> <tr> <th scope="row">Header type</th> <td> Request header </td> </tr> <tr> <th scope="row">Forbidden request header</th> <td>No</td> </tr> </tbody> </table>

Syntax

Prefer: <preference>, <preference>, ...

Directives

  • respond-async
    • : The client prefers asynchronous processing. For example, the server might respond with 202 response indicated that the request has been accepted, along with the Location header that has a URL that the client can use to monitor the state of the processing.
  • return=minimal
    • : Requests that the server return minimal content (a headers-only response).
  • return=representation
    • : Requests a full resource representation in the response.
  • wait=<seconds>
    • : The time within which the client expects the server to provide a response, from the point at which the request was received. If the respond-async preference is also provided, the server should respond asynchronously if processing the request will exceed the wait time. Otherwise, the server should consider that the client will timeout after the wait time (response behavior depends on server implementation).
  • handling=lenient
    • : The client wishes the server to apply lenient validation and error handling to the processing of the request.
  • handling=strict
    • : The client wishes the server to apply strict validation and error handling to the processing of the request.
  • Custom preference
    • : Vendors or applications may define their own preferences to suit specific needs. For example, Prefer: timezone=America/Los_Angeles.

Examples

Requesting minimal response

The following request asks for a minimal response. This is typically a headers-only response (as opposed to return=representation where a representation is included in the response body):

POST /resource HTTP/1.1
Host: example.com
Content-Type: application/json
Prefer: return=minimal

{"id":123, "name": "abc"}

The server responds with a 201, but does not include any response body. The Location header contains a URL with the location of the newly-created resource. There's no need to include a Preference-Applied header because the absence of a response body is readily apparent:

HTTP/1.1 201 Created
Location: /resource?id=123

Requesting asynchronous processing

This example requests the server start an async processing task:

POST /process HTTP/1.1
Host: example.com
Prefer: respond-async

{
  "task": "check-broken-links"
}

The server responds with a 202 response indicated the request has been accepted and has not yet completed executing asynchronously. A Location header points to a status monitor that represents the state of the processing:

HTTP/1.1 202 Accepted
Location: http://example.com/tasks/123/status

Providing multiple preferences

The following request includes two preferences; timezone=Jupiter/Red_Spot indicating a time zone preference for the client, and handling=strict for strict validation:

GET /events HTTP/1.1
Host: example.com
Prefer: handling=strict, timezone=Jupiter/Red_Spot

In this implementation, an invalid time zone will throw an error:

HTTP/1.1 400 Bad Request

Specifications

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。