Hypermedia

(Difference between revisions)
Jump to: navigation, search
m (1 revision)
Line 30: Line 30:
 
* [[Common Features]]
 
* [[Common Features]]
  
 +
{{disqus}}
 
[[Category:Hostway API]]
 
[[Category:Hostway API]]

Revision as of 16:47, 15 February 2013

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.

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.

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox