Re: [xwiki-devs] Eclipse building instruction for Xwiki

Hi Karamjit, For an example of adding new resources to the XWiki REST API, you could look at how the XWiki Annotation feature did it [1]. For the steps you need to take, you have to: 1. Create a new maven project that deppends on xwiki-platform-rest-server (for xwiki >3.1) and some other dependencies that you might need. See [2] 2. Add a new resource by adding a new class that extends XWikiResource (like [3] does) and that declares itself as a component and specifies the REST URI that it will honor (like [4] does). As Marius pointed out, [9] helps, but by looking at the examples pointed by [9] you will learn much faster. 3. Even if you declared your resources as components (@Component+@Namedattributes), you still have to register them in component.txt (like [5] does) so that the component manager can detect them. 4. If you need to return or accept complex types (other than basic strings, numbers, etc), you need to define your model by using a schema (like [6]) and then configure your maven artifact to run, at build time, the 'org.jvnet.jaxb2.maven2' plugin that generates java classes out of the schema definition for you to use in your resources. You might also need to provide a simple.jxb bindings file (like [8]) to handle dates properly. 5. Build your maven artefact containing the new resources and you get a .jar file 6. Copy that jar file into '<xwiki_installation_dir>/webapps/xwiki/WEB-INF/lib/'. Remember that the installed XWiki version must match the version you developed your resources for, otherwise the jars will risk not matching. 7. Restart XWiki and access your new resources by using the URI you specified for them at step 2. Yor URL will be in the form of " http://localhost:8080/xwiki/rest/<URI>"I>". I hope I did not miss anything and that it's clear enough. Good luck, Eduard ----------------- References: [1] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [2] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [3] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [4] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [5] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [6] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [7] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [8] https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwi… [9] http://platform.xwiki.org/xwiki/bin/view/Features/XWikiRESTfulAPI#HCustomre… On Fri, Jul 22, 2011 at 8:01 AM, Marius Dumitru Florea < mariusdumitru.florea(a)xwiki.com&gt; wrote: