Changes

Jump to navigation Jump to search
223 bytes added ,  17:14, 9 March 2023
no edit summary
=Conventions=
* The module will be available if the {{Code|basex-api}} package must be included library is found in the classpath. This is always the case if you use one of the complete distributions of BaseX (zip, exe, war) of BaseX.* All functions are assigned to the <code><nowiki>http://exquery.org/ns/restxq</nowiki></code> namespace. The module must be imported in the query prolog:<pre class="brush:xquery">import module namespace rest = "http://exquery.org/ns/restxq";...</pre>* In this documentation, the namespace which is statically bound to the {{Code|rest}} prefix, and the .* 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, the error {{Error|BXSE0003|<code>[[XQuery Errors#BaseX Errors}} |basex:http]]</code> is raised.
=General Functions=
{| 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.
|}
==rest:init==
 
{{Mark|Introduced with Version 8.6}}:
{| 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:* By default, the cache will be discarded, and all modules will be parsed and cached again. This function should be called if * If {{OptionCode|CACHERESTXQ$update}} is enabled and , the background caching behavior is simulated (see {{Option|PARSERESTXQ}}): Only updated modules will be parsed.* This function should be called if new RESTXQ modules are replaced while the web server code is runningdeployed 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.
Bureaucrats, editor, reviewer, Administrators
13,554

edits

Navigation menu