Changes for page REST API

Last modified by Thomas Mortagne on 2024/03/12

<
From version < 7.1 >
edited by Fabio Mancinelli
on 2009/03/21
To version < 8.2 >
edited by Silvia Macovei
on 2009/09/25
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.fmancinelli
1 +XWiki.SilviaRusu
Content
... ... @@ -16,7 +16,7 @@
16 16  Resources in XWiki are pages, attachments, objects, properties, spaces, and all the ~~things~~ we described in the previous section. XWiki has a default way of conveying the information about these resources, i.e., by providing well defined XML representations that contain all the information associated to the resource in an XML format.
17 17  This format is described using an XML Schema Definition file that can be found here: [http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rest/src/main/resources/xwiki.rest.model.xsd]
18 18  
19 -Of course the same resource can be represented in many different way. When it is the case, this will be documented.
19 +Of course the same resource can be represented in many different ways. When it is the case, this will be documented.
20 20  
21 21  Another important aspect of representations is that they contain useful information for linking related resources. This is a realization of the ~~Hypermedia As The Engine Of The Application State (HATEOAS)~~ principle. In XML representations this information is conveyed through the <tt>&lt;link&gt;</tt> tag. This tag has two important parameters: *rel* and *href*. *rel* specifies the "semantics" of the link, while *href* is the URI of the linked resource.
22 22  
... ... @@ -63,6 +63,7 @@
63 63  
64 64  This graph shows that by starting from the API entry-point a client can navigate and discover all the resources just by following the links provided in representations (and by knowing their semantics). This was exactly the way how this graph was generated.
65 65  
66 +
66 66  1.1 Interacting with the XWiki RESTful API
67 67  
68 68  The XWiki RESTful API is accessible through HTTP so, in principle, you can use every client that is capable of "speaking" HTTP in order to interact with it. Even a web browser!

Get Connected