Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
no edit summary
* The module will be available if the {{Code|basex-api}} library is found in the classpath. This is the case if you use one of the complete distributions of BaseX (zip, exe, war).
* All functions are assigned to the <code><nowiki>http://exquery.org/ns/restxq</nowiki></code> namespace, which is statically bound to the {{Code|rest}} prefix. Prior to {{Version|9.2}}, the module needed to be imported in the query prolog:<pre class="brush:xquery">import module namespace rest = "http://exquery.org/ns/restxq";...</pre>* In this document, the namespace is bound to the {{Code|rest}} prefix.
* The <code><nowiki>http://wadl.dev.java.net/2009/02</nowiki></code> namespace is bound to the {{Code|wadl}} prefix.
* If any of the functions is called outside the servlet context, <code>[[XQuery Errors#BaseX Errors|basex:http]]</code> is raised.
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>rest:base-uri||() as xs:anyURI}}</pre>|-valign="top"
| '''Summary'''
|Returns the implementation-defined base URI of the resource function.
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>rest:uri||() as xs:anyURI}}</pre>|-valign="top"
| '''Summary'''
|Returns the complete URI that addresses the Resource Function. This is the result of [[#rest:base-uri{{Function||rest:base-uri]] }} appended with the path from the path annotation of the resource function.
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>rest:wadl||() as element(wadl:application)}}</pre>|-valign="top"
| '''Summary'''
|Returns a [httphttps://www.w3.org/Submission/wadl WADL description] of all available REST services.
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>rest:init||( $update as xs:boolean? := false()) as empty-sequence()}}</pre>|-valign="top"
| '''Summary'''
|Initializes the RESTXQ module cache. This function should :* By default, the cache will be called after RESTXQ discarded, and all modules have been replaced while the web server is running, will be parsed and if cached again.* If {{OptionCode|PARSERESTXQ$update}} is not set to enabled, the background caching behavior is simulated (see {{CodeOption|0PARSERESTXQ}}): Only updated modules will be parsed.* This function should be called if new RESTXQ code is deployed at runtime.
|}
=Changelog=
; Version 9.4
* Updated: {{Function||rest:init}} argument added
;Version 8.6
* Added: [[#rest:init{{Function||rest:init]]}}
This module was introduced with Version 7.7.
