Changes

Jump to navigation Jump to search
695 bytes added ,  17:14, 9 March 2023
no edit summary
=Conventions=
* This The module will be available if the {{Code|basex-api}} library is included found in the classpath. This is the case if you use one of the complete distributions of BaseX (zip, exe, war) of BaseX.* All functions are assigned to the {{Code|<code><nowiki>http://exquery.org/ns/restxq}} namespace, which must be dynamically imported:<pre class="brush:xquery"/nowiki>import module namespace rest = "http://exquery.org/ns/restxq";...</precode>* In this documentationnamespace, the namespace which is statically bound to the {{Code|rest}} prefix, and the {{Code|.* 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=
==restxqrest:base-uri== 
{| width='100%'
|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|restxq<pre>rest:base-uri||() as xs:anyURI}}</pre>|-valign="top"
| '''Summary'''
|This function returns Returns the implementation -defined base URI of the resource function.
|}
==restxqrest:uri== 
{| width='100%'
|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|restxq<pre>rest:base-uri||() as xs:anyURI}}</pre>|-valign="top"
| '''Summary'''
|This function returns 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.
|}
==restxqrest:wadl== 
{| width='100%'
|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|restxq<pre>rest:wadl||() as element(wadl:application)}}</pre>|-valign="top"
| '''Summary'''
|This (unofficial) function returns Returns a [https://www.w3.org/Submission/wadl WADL description] of all available REST services.|} ==rest:init== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<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.* If {{Code|$update}} is enabled, the background caching behavior is simulated (see {{Option|PARSERESTXQ}}): Only updated modules will be parsed.* This function should be called if new RESTXQ code is deployed at runtime.
|}
=Changelog=
This module was introduced with ; Version 79.54* Updated: {{Function||rest:init}} argument added ;Version 8.6* Added: {{Function||rest:init}}
[[Category:XQuery]]This module was introduced with Version 7.7.
Bureaucrats, editor, reviewer, Administrators
13,554

edits

Navigation menu