API Reference
XWiki's APIs are the methods that the XWiki development team consider safe for you to use (i.e. for which backward compatibility is guaranteed). They can be called from Java or directly from your wiki pages using a scripting language (Velocity, Groovy, Python, Ruby, etc).
Scripting Reference Documentation
In order to know the full list of APIs that you can use you can:
- (Recommended) Install the Scripting Documentation Application in your wiki.
- Browse a version of it installed on xwiki.org (but beware, it'll show the Scripting API available on the XWiki version installed for xwiki.org, which may differ from your locally installed XWiki version).
How to find a class
You can get the maven module where to find a Java class by using XWiki Nexus Search page. Put the complete class name and you will get all modules containing it. Nexus also allows you to see what's in those artifacts and read the JavaDoc.
JavaDoc
XWiki is made of various extensions/modules and each module offers API for both developers coding in Java and for Scripts written in wiki pages. In the future our goal is to have JavaDoc links directly from each extension page located in the Extensions Wiki.
Right now we're providing all JavaDocs for all modules:
The full JavaDoc is also available ( ).
Older JavaDocs of XWiki can be found in our Maven Release repository. For example for XWiki Platform Core JavaDocs, check the files suffixed by javadoc for the version you wish under this directory.