XWiki开发团队考虑到安全使用(即,保证后向兼容性)。我们可以从Java或直接从wiki页面使用一个脚本语言 (Velocity, Groovy, Python, Ruby等)调用API。
作为XWiki API的使用者,你需要知道一些要点:
- 你不应该使用一个class里面有internal关键字。这意味着这个class不是一个public API以及XWiki开发者可以在任何时候改变它。如果你依赖于这样的一个类,XWiki开发团队是不保证其稳定性。
- 你应该注意@Unstable注解。当你看到标有此注解的代码就意味着它是一个新的公共API,仍然被认为是不稳定的,并且可以随时更改。查看Unstable注解了解更多信息。
脚本参考文档
如何找到一个类
你可以通过使用XWiki Nexus 查询页面获得maven模块来查找一个Java类。输入一个完整的类名,你就可以得到所有包含该类的模块。Nexus还允许让你查看artifacts和阅读javadoc。
JavaDoc
XWiki由各种扩展/模块组成,每个模块都为开发者用JAVA编程和wiki页面编写脚本提供了API。在未来我们的目标是直接在扩展wiki的每个扩展页面提供Javadoc链接。
目前,我们为所有模块提供了所有Javadoc文档:
完整Javadoc(但只有旧版本,我们需要解决这个问题).
更旧的Javadocs可以在Maven Release repository里找到。例如,对于XWiki Platform Core的Javadoc,可以在这个目录下找到相应版本的javadoc。