Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
→Usage
All RESTXQ [[XQuery 3.0#Annotations|annotations]] are assigned to the {{Code|http://exquery.org/ns/restxq}} namespace, which is statically bound to the {{Code|restxq}} prefix (and since {{Version|7.7}}: {{Code|rest}}). A ''Resource Function'' is an XQuery function that has been marked up with RESTXQ annotations. When an HTTP request comes in, a resource function will be invoked that matches the constraints indicated by its annotations.
Whenever a RESTXQ URL is requested, the [[Options#RESTXQPATH|RESTXQPATH]] module directory and its sub-directories will be scanned for functions with annotations. RESTXQ functions may occur in library modules (detected by the extension {{Code|.xqm}}) and (since {{Version|7.7}}) main modules (detected by {{Code|.xq}}). All modules will be cached and parsed again when the their timestamp changes.
A simple RESTXQ module is shown below, it is part of a clean installation and available at http://localhost:8984/restxq/ .
