Link Header: Difference between revisions
Jump to navigation
Jump to search
(Created page with "Link headers are a way to signal available actions to clients. Which actions can be available and how you can perform these actions are documented in the Media-Type specific...") |
|||
| Line 4: | Line 4: | ||
== Common Links == | == Common Links == | ||
* | * <code>rel=self</code>: This is the [[Canonical URL | canonical URL]] for this resource. PUT and DELETE requests should generally be done here. | ||
* | * <code>rel=next</code>: The next page in a list | ||
* | * <code>rel=prev</code>: The previous page in a list | ||
* | * <code>rel=first</code>: The first page in a list | ||
* | * <code>rel=last</code>: The last page in a list | ||
A full list of publicly registered relation types can be found on the [https://www.iana.org/assignments/link-relations/link-relations.xhtml IANA Link Relations page]. | A full list of publicly registered relation types can be found on the [https://www.iana.org/assignments/link-relations/link-relations.xhtml IANA Link Relations page]. | ||
Revision as of 18:42, 15 January 2021
Link headers are a way to signal available actions to clients. Which actions can be available and how you can perform these actions are documented in the Media-Type specification corresponding to the Content-Type you got back from the server.
Links are identified using their `rel` parameter and always have a `href`.
Common Links
rel=self: This is the canonical URL for this resource. PUT and DELETE requests should generally be done here.rel=next: The next page in a listrel=prev: The previous page in a listrel=first: The first page in a listrel=last: The last page in a list
A full list of publicly registered relation types can be found on the IANA Link Relations page.
Additional Properties
A link can have other optional properties as well, an example is the `templated=true` property that should be added if a client is supposed to fill in a URL Template.