Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Created page with "This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the [http://exquery.github.io/exquery/exquery-restxq-specific..."
This [[Module Library|XQuery Module]] contains helper functions for the [[RESTXQ]] API, some of which are defined in the [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ Draft].
=Conventions=
* This module is included in the complete distributions (zip, exe, war) of BaseX.
* All functions are assigned to the {{Code|http://exquery.org/ns/restxq}} namespace, which must be dynamically imported:
<pre class="brush:xquery">
import module namespace rest = "http://exquery.org/ns/restxq";
...
</pre>
* In this documentation, the namespace is bound to the {{Code|rest}} prefix, and the {{Code|http://wadl.dev.java.net/2009/02}} namespace is bound to the {{Code|wadl}} prefix.
* If any of the functions is called outside the servlet context, the error {{Error|BXSE0003|#Errors}} is raised.
=General Functions=
==restxq:base-uri==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|restxq:base-uri||xs:anyURI}}
|-
| '''Summary'''
|This function returns the implementation defined base URI of the resource function.
|}
==restxq:uri==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|restxq:base-uri||xs:anyURI}}
|-
| '''Summary'''
|This function returns the complete URI that addresses the Resource Function. This is the result of [[#rest:base-uri|rest:base-uri]] appended with the path from the path annotation of the resource function.
|}
==restxq:wadl==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|restxq:wadl||element(wadl:application)}}
|-
| '''Summary'''
|This (unofficial) function returns a [WADL description] of all available REST services.
|}
=Changelog=
This module was introduced with Version 7.5.
[[Category:XQuery]]
=Conventions=
* This module is included in the complete distributions (zip, exe, war) of BaseX.
* All functions are assigned to the {{Code|http://exquery.org/ns/restxq}} namespace, which must be dynamically imported:
<pre class="brush:xquery">
import module namespace rest = "http://exquery.org/ns/restxq";
...
</pre>
* In this documentation, the namespace is bound to the {{Code|rest}} prefix, and the {{Code|http://wadl.dev.java.net/2009/02}} namespace is bound to the {{Code|wadl}} prefix.
* If any of the functions is called outside the servlet context, the error {{Error|BXSE0003|#Errors}} is raised.
=General Functions=
==restxq:base-uri==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|restxq:base-uri||xs:anyURI}}
|-
| '''Summary'''
|This function returns the implementation defined base URI of the resource function.
|}
==restxq:uri==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|restxq:base-uri||xs:anyURI}}
|-
| '''Summary'''
|This function returns the complete URI that addresses the Resource Function. This is the result of [[#rest:base-uri|rest:base-uri]] appended with the path from the path annotation of the resource function.
|}
==restxq:wadl==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|restxq:wadl||element(wadl:application)}}
|-
| '''Summary'''
|This (unofficial) function returns a [WADL description] of all available REST services.
|}
=Changelog=
This module was introduced with Version 7.5.
[[Category:XQuery]]
