Changes for page REST API

Last modified by Thomas Mortagne on 2024/03/12

<
From version < 39.1 >
edited by Fabio Mancinelli
on 2012/11/07
To version < 40.1 >
edited by Fabio Mancinelli
on 2012/11/07
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -927,6 +927,16 @@
927 927  
928 928  You can find more examples on [[https://github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-server/src/main/java/org/xwiki/rest/resources]].
929 929  
930 +Starting from release 4.3M2, the RESTful API modules have been refactored so that now resource declarations are available in a separate module.
931 +This means that all the information about resources, i.e., URI Paths, supported methods, query parameters, and so on, are available to module developers without having to include the big REST Server module.
932 +
933 +Clients willing to access/use the REST API can then declare a dependency on xwiki-platform-rest-api and have all this information available for interacting with it. There are two use cases for this:
934 +* Another platform module that wants to generate responses with links to existing resources.
935 +* HTTP clients that wants to make requests to the RESTful API.
936 +
937 +The xwiki-platform-rest-api module can be also seen as an authoritative reference for the REST API.
938 +
939 +
930 930  = Using the RESTful API =
931 931  
932 932  == Highlevel description and tutorial for a basic usage of the RESTful API ==

Get Connected