Content negotiation: Difference between revisions
No edit summary |
DeathcatThor (talk | contribs) m Added a link on Internet Explorer |
||
| (48 intermediate revisions by 40 users not shown) | |||
| Line 1: | Line 1: | ||
{{Short description|Serving multiple documents at the same URI}} |
|||
{{HTTP}} |
{{HTTP}} |
||
'''Content negotiation''' |
'''Content negotiation''' refers to mechanisms defined as a part of [[HTTP]] that make it possible to serve different versions of a document (or more generally, representations of a resource) at the same [[Uniform Resource Identifier|URI]], so that [[user agent]]s can specify which version fits their capabilities the best. One classical use of this mechanism is to serve an image in [[GIF]] or [[Portable Network Graphics|PNG]] format, so that a browser that cannot display PNG images (e.g. [[Internet Explorer|MS Internet Explorer]] 4) will be served the GIF version. |
||
A resource may be available in several different representations; for example, it might be available in different languages or different media types. One way of selecting the most appropriate choice is to give the user an index page and let them select the most appropriate choice; however it is often possible to automate the choice based on some selection criteria. |
|||
==Mechanisms== |
|||
| ⚫ | |||
HTTP provides for several different content negotiation mechanisms including: server-driven (or proactive), agent-driven (or reactive), transparent, and/or hybrid combinations thereof. |
|||
===Server-driven=== |
|||
Note that this preference will only be applied when there is a choice of representations and they vary by language. |
|||
Server-driven or proactive content negotiation is performed by algorithms on the server which choose among the possible variant representations. This is commonly performed based on user agent-provided acceptance criteria. |
|||
To summarize how this works, when a user agent submits a request to a server, the user agent informs the server what [[media type]]s or other aspects of content presentation it understands with ratings of how well it understands them. More precisely, the user agent provides [[List of HTTP header fields|HTTP header]]s that lists acceptable aspects of the resource and quality factors for them. The server is then able to supply the version of the resource that best fits the user agent's needs. |
|||
As an example of a more complex request, this browser has been configured to accept German and English, but prefer German, and to accept various media types, preferring HTML over plain text or other text types, and preferring GIF or [[JPEG]] over other media types, but also allowing any other media type as a last resort: |
|||
For example, a browser could indicate that it would like information in German by setting the <code>Accept-Language</code> like this: |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
In addition to content negotiation by [[Internet media type|content type]] and by [[IETF language tag|language]], there is an extension to use content negotiation to retrieve prior version in time with the <code>Accept-Datetime</code> header.<ref>[http://www.mementoweb.org/ Memento: Adding Time to the Web]. Mementoweb.org. Retrieved on 2013-09-08.</ref> |
|||
The browser may instead say that German is preferred, if possible, but that English is also acceptable by setting: |
|||
| ⚫ | |||
| ⚫ | |||
== Content format == |
|||
The user-agent can request the data in a certain format from a web service, such as <tt>application/json</tt> or <tt>application/xml</tt>. |
|||
Where the 'q' - quality - factor for German is higher than that for English. |
|||
==See also== |
|||
Multiple HTTP headers are often supplied together for content format or, specifically media type, language and a few other aspects of a resource. In addition to the commonly used <code>Accept</code> header for Media Type, the <code>Accept-Language</code> header for language negotiation, RFC 7231 also describes <code>Accept-Charset</code> & <code>Accept-Encodings</code> for character encodings and content codings (compression) respectively. |
|||
* [[Apache HTTP Server]] |
|||
An example of a more complex request is where a browser sends headers about language indicating German is preferred but that English is acceptable, as above, and that, regarding formats, [[HTML]] (<code>text/html</code>) is preferred over other text types (<code>text/*</code>), GIF (<code>image/gif</code>) or [[JPEG]] (<code>image/jpg</code>) images are preferred over other image formats (<code>image/*</code>) but that any other media type (<code>*/*</code>) is accepted as a last resort: |
|||
== References == |
|||
<syntaxhighlight lang="email">Accept-Language: de; q=1.0, en; q=0.5 |
|||
<references/> |
|||
| ⚫ | |||
In addition to aspects of server-driven content negotiation by [[Internet media type|content type]] and by [[IETF language tag|language]] specified in RFC 7231, there are extensions defining other aspects of content negotiation, such as ''Memento'' which describes use of a <code>Accept-Datetime</code> header to retrieve version of a resource's representation at particular points in time<ref>[http://www.mementoweb.org/ Memento: Adding Time to the Web]. Mementoweb.org. Retrieved on 2013-09-08.</ref> and the IETF/W3C's ''Content Negotiation by Profile''<ref name="connegp">{{cite web|url=https://www.w3.org/TR/dx-prof-conneg/ | title=World Wide Web Consortium (W3C), "Content Negotiation by Profile", W3C Working Draft, 26 November 2019.}}</ref> which describes use of an <code>Accept-Profile</code> header to retrieve resource representations conforming to data profiles. |
|||
| ⚫ | Neither RFC 7231 nor the more recent related specifications such as ''Content Negotiation by Profile''<ref name="connegp" /> specify how to resolve trade-offs in cases where different headers specify conflicting requirements, such as, in the above example, choosing between an HTML page in English and a GIF image in German. |
||
| ⚫ | |||
| ⚫ | |||
===Agent-driven=== |
|||
| ⚫ | |||
{{See also|Adaptive web design}} |
|||
| ⚫ | |||
Agent-driven or reactive content negotiation is performed by algorithms in the user-agent which choose among the possible variant representations. This is commonly performed based on a server provided list of representations and metadata about them. |
|||
| ⚫ | |||
| ⚫ | |||
To summarize how this works, when a user agent submits a request to a server, the server informs the user-agent which representations it has available as well as any metadata it has about each representation (e.g., content-type, quality, language, etc.). The user-agent then resubmits the request to a specific URL for the chosen representation. This can be automatically chosen by the user-agent or the user-agent can present the user with the choices and the user can directly choose such. More precisely, the server responds with either 300 Multiple Choices or 406 Not Acceptable (when server-driven, user-agent acceptance criteria are provided but the server cannot automatically make a selection). Unfortunately HTTP leaves the format of the list of representations and metadata along with selection mechanisms unspecified. |
|||
| ⚫ | |||
<!-- Expand on these later |
|||
* [http://dragoman.org/variant The variant button] |
|||
===Transparent=== |
|||
* [http://httpd.apache.org/docs/2.0/mod/mod_negotiation.html Apache 2.0 Content Negotiation Info] |
|||
===Hybrid=== |
|||
--> |
|||
==References== |
==References== |
||
{{reflist}} |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | :This article is based in part on [http://httpd.apache.org/docs/1.3/content-negotiation.html this page] {{Webarchive|url=https://web.archive.org/web/20141115001512/http://httpd.apache.org/docs/1.3/content-negotiation.html |date=2014-11-15 }}, which is copyrighted by the Apache Foundation but released under a free license. |
||
[[Category:Hypertext Transfer Protocol]] |
[[Category:Hypertext Transfer Protocol]] |
||
Latest revision as of 18:42, 23 September 2024
| HTTP |
|---|
 |
| Request methods |
| Header fields |
| Response status codes |
| Security access control methods |
| Security vulnerabilities |
Content negotiation refers to mechanisms defined as a part of HTTP that make it possible to serve different versions of a document (or more generally, representations of a resource) at the same URI, so that user agents can specify which version fits their capabilities the best. One classical use of this mechanism is to serve an image in GIF or PNG format, so that a browser that cannot display PNG images (e.g. MS Internet Explorer 4) will be served the GIF version.
A resource may be available in several different representations; for example, it might be available in different languages or different media types. One way of selecting the most appropriate choice is to give the user an index page and let them select the most appropriate choice; however it is often possible to automate the choice based on some selection criteria.
Mechanisms
[edit]HTTP provides for several different content negotiation mechanisms including: server-driven (or proactive), agent-driven (or reactive), transparent, and/or hybrid combinations thereof.
Server-driven
[edit]Server-driven or proactive content negotiation is performed by algorithms on the server which choose among the possible variant representations. This is commonly performed based on user agent-provided acceptance criteria.
To summarize how this works, when a user agent submits a request to a server, the user agent informs the server what media types or other aspects of content presentation it understands with ratings of how well it understands them. More precisely, the user agent provides HTTP headers that lists acceptable aspects of the resource and quality factors for them. The server is then able to supply the version of the resource that best fits the user agent's needs.
For example, a browser could indicate that it would like information in German by setting the Accept-Language like this:
Accept-Language: de
The browser may instead say that German is preferred, if possible, but that English is also acceptable by setting:
Accept-Language: de; q=1.0, en; q=0.5
Where the 'q' - quality - factor for German is higher than that for English.
Multiple HTTP headers are often supplied together for content format or, specifically media type, language and a few other aspects of a resource. In addition to the commonly used Accept header for Media Type, the Accept-Language header for language negotiation, RFC 7231 also describes Accept-Charset & Accept-Encodings for character encodings and content codings (compression) respectively.
An example of a more complex request is where a browser sends headers about language indicating German is preferred but that English is acceptable, as above, and that, regarding formats, HTML (text/html) is preferred over other text types (text/*), GIF (image/gif) or JPEG (image/jpg) images are preferred over other image formats (image/*) but that any other media type (*/*) is accepted as a last resort:
Accept-Language: de; q=1.0, en; q=0.5
Accept: text/html; q=1.0, text/*; q=0.8, image/gif; q=0.6, image/jpeg; q=0.6, image/*; q=0.5, */*; q=0.1
In addition to aspects of server-driven content negotiation by content type and by language specified in RFC 7231, there are extensions defining other aspects of content negotiation, such as Memento which describes use of a Accept-Datetime header to retrieve version of a resource's representation at particular points in time[1] and the IETF/W3C's Content Negotiation by Profile[2] which describes use of an Accept-Profile header to retrieve resource representations conforming to data profiles.
Neither RFC 7231 nor the more recent related specifications such as Content Negotiation by Profile[2] specify how to resolve trade-offs in cases where different headers specify conflicting requirements, such as, in the above example, choosing between an HTML page in English and a GIF image in German.
Agent-driven
[edit]Agent-driven or reactive content negotiation is performed by algorithms in the user-agent which choose among the possible variant representations. This is commonly performed based on a server provided list of representations and metadata about them.
To summarize how this works, when a user agent submits a request to a server, the server informs the user-agent which representations it has available as well as any metadata it has about each representation (e.g., content-type, quality, language, etc.). The user-agent then resubmits the request to a specific URL for the chosen representation. This can be automatically chosen by the user-agent or the user-agent can present the user with the choices and the user can directly choose such. More precisely, the server responds with either 300 Multiple Choices or 406 Not Acceptable (when server-driven, user-agent acceptance criteria are provided but the server cannot automatically make a selection). Unfortunately HTTP leaves the format of the list of representations and metadata along with selection mechanisms unspecified.
References
[edit]- ^ Memento: Adding Time to the Web. Mementoweb.org. Retrieved on 2013-09-08.
- ^ a b "World Wide Web Consortium (W3C), "Content Negotiation by Profile", W3C Working Draft, 26 November 2019".
External links
[edit]- RFC 7231 — Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content – (Section 5.3: Content Negotiation)
- RFC 2295 — Transparent Content Negotiation in HTTP
- RFC 2296 — HTTP Remote Variant Selection Algorithm -- RVSA/1.0
- Apache Content Negotiation
- Open source PHP content negotiation library (supports wildcards and q values)
- Discussion about XHTML serving with content negotiation and browser concerns requiring this
- This article is based in part on this page Archived 2014-11-15 at the Wayback Machine, which is copyrighted by the Apache Foundation but released under a free license.