XWiki API Reference

Last modified by Vincent Massol on 2013/05/21 13:10

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).

As users of the XWiki API you need to be aware of some important points:

  • You should never use a class having internal in its package. It means this class is not a public API and XWiki developers can change it at any time. If you depend on such a class you're on your own and the XWiki Development Team doesn't guarantee its stability.
  • You should pay attention to the @Unstable annotation. When you see code marked with this annotation it means it's a new public API that it still considered unstable and that can change at any time too. See Unstable Annotation for more details.

Scripting Reference Documentation

You can now browse the XWiki APIs using the Scripting Reference Documentation.

Other documentations

The latest scripting API documentation is available as JavaDoc:

You might also be interested in the Rendering Engine API JavaDoc.

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.

Tags:
Created by VincentMassol on 2006/12/05 16:35

About

Projects

XWiki Enterprise

Extensions

XWiki Manager

Other

Platform

User Guide

Admin Guide

Developer Guide

Contribute

Status

Under the Hood

Practices

Get Involved

Support

Get Connected

Powered by XWiki Enterprise 4.5.2