Hypermedia
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 97) |
|||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
== JSON == | == JSON == | ||
| − | In the JSON representation | + | In the JSON representation the hypermedia is included in the links field of the JSON object. |
| − | + | <nowiki> | |
| − | < | + | |
{ | { | ||
"links":[ | "links":[ | ||
{ | { | ||
| − | "href":"http:// | + | "href":"http://{api_server}/flavors/{flavor_id}/", |
"rel":"self" | "rel":"self" | ||
}, | }, | ||
{ | { | ||
| − | "href":"http:// | + | "href":"http://{api_server}/flavors/{flavor_id}/", |
"rel":"bookmark" | "rel":"bookmark" | ||
| − | } | + | } |
] | ] | ||
} | } | ||
| − | </ | + | </nowiki> |
| − | + | ||
; href | ; href | ||
| Line 25: | Line 23: | ||
; rel | ; rel | ||
| − | : Describes the relationship of this resources to the resource at the href URL. | + | : Describes the relationship of this resources to the resource at the href URL. See [http://www.iana.org/assignments/link-relations/link-relations.xml] for list of standard relationship types. |
: '''self''' - This is a link to the full version of this resource. Most listings will give a truncated version of the resource and include a self link. | : '''self''' - This is a link to the full version of this resource. Most listings will give a truncated version of the resource and include a self link. | ||
: '''bookmark''' - This is a permalink to the current stable API version of this resource. | : '''bookmark''' - This is a permalink to the current stable API version of this resource. | ||
| + | == See also == | ||
| + | * [[Common Features]] | ||
| − | + | {{disqus}} | |
| − | + | [[Category:Common Features]] | |
| − | {{ | + | [[Category:Hostway API]] |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Latest revision as of 12:48, 20 August 2014
Hypermedia is used to describe the relationships between resources. It is suggested that clients use the hypermedia to browse between resource and not build URLs with templates.
[edit] JSON
In the JSON representation the hypermedia is included in the links field of the JSON object.
{
"links":[
{
"href":"http://{api_server}/flavors/{flavor_id}/",
"rel":"self"
},
{
"href":"http://{api_server}/flavors/{flavor_id}/",
"rel":"bookmark"
}
]
}
- href
- The absolute URL of the resource.
- rel
- Describes the relationship of this resources to the resource at the href URL. See [1] for list of standard relationship types.
- self - This is a link to the full version of this resource. Most listings will give a truncated version of the resource and include a self link.
- bookmark - This is a permalink to the current stable API version of this resource.
[edit] See also
