Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
(6 intermediate revisions by the same user not shown) | |||
Line 13: | Line 13: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>rest:base-uri() as xs:anyURI</pre> |
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the implementation-defined base URI of the resource function. | |Returns the implementation-defined base URI of the resource function. | ||
Line 24: | Line 24: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>rest:uri() as xs:anyURI</pre> |
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
− | |Returns the complete URI that addresses the Resource Function. This is the result of | + | |Returns the complete URI that addresses the Resource Function. This is the result of {{Function||rest:base-uri}} appended with the path from the path annotation of the resource function. |
|} | |} | ||
Line 35: | Line 35: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>rest:wadl() as element(wadl:application)</pre> |
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
− | |Returns a [ | + | |Returns a [https://www.w3.org/Submission/wadl WADL description] of all available REST services. |
|} | |} | ||
==rest:init== | ==rest:init== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>rest:init( |
− | |- | + | $update as xs:boolean? := false() |
+ | ) as empty-sequence()</pre> | ||
+ | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
|Initializes the RESTXQ module cache: | |Initializes the RESTXQ module cache: | ||
Line 62: | Line 62: | ||
; Version 9.4 | ; Version 9.4 | ||
− | * Updated: | + | * Updated: {{Function||rest:init}} argument added |
;Version 8.6 | ;Version 8.6 | ||
− | * Added: | + | * Added: {{Function||rest:init}} |
This module was introduced with Version 7.7. | This module was introduced with Version 7.7. |
Latest revision as of 17:14, 9 March 2023
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Conventions[edit]
- The module will be available if the
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
http://exquery.org/ns/restxq
namespace, which is statically bound to therest
prefix. - The
http://wadl.dev.java.net/2009/02
namespace is bound to thewadl
prefix. - If any of the functions is called outside the servlet context,
basex:http
is raised.
General Functions[edit]
rest:base-uri[edit]
Signature | rest:base-uri() as xs:anyURI |
Summary | Returns the implementation-defined base URI of the resource function. |
rest:uri[edit]
Signature | rest:uri() as xs:anyURI |
Summary | Returns the complete URI that addresses the Resource Function. This is the result of rest:base-uri appended with the path from the path annotation of the resource function.
|
rest:wadl[edit]
Signature | rest:wadl() as element(wadl:application) |
Summary | Returns a WADL description of all available REST services. |
rest:init[edit]
Signature | rest:init( $update as xs:boolean? := false() ) as empty-sequence() |
Summary | Initializes the RESTXQ module cache:
|