Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
m (Text replacement - "'''Signatures'''" to "'''Signature'''") |
|||
Line 14: | Line 14: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>rest:base-uri() as xs:anyURI</pre> | |<pre>rest:base-uri() as xs:anyURI</pre> | ||
|- valign="top" | |- valign="top" | ||
Line 25: | Line 25: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>rest:uri() as xs:anyURI</pre> | |<pre>rest:uri() as xs:anyURI</pre> | ||
|- valign="top" | |- valign="top" | ||
Line 36: | Line 36: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>rest:wadl() as element(wadl:application)</pre> | |<pre>rest:wadl() as element(wadl:application)</pre> | ||
|- valign="top" | |- valign="top" | ||
Line 47: | Line 47: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>rest:init( | |<pre>rest:init( | ||
$update as xs:boolean := () | $update as xs:boolean := () |
Revision as of 15:01, 9 March 2023
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Contents
Conventions
- 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
rest:base-uri
Signature | rest:base-uri() as xs:anyURI |
Summary | Returns the implementation-defined base URI of the resource function. |
rest:uri
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
Signature | rest:wadl() as element(wadl:application) |
Summary | Returns a WADL description of all available REST services. |
rest:init
Signature | rest:init( $update as xs:boolean := () ) as empty-sequence() |
Summary | Initializes the RESTXQ module cache:
|
Changelog
- Version 9.4
- Updated:
rest:init
argument added
- Version 8.6
- Added:
rest:init
This module was introduced with Version 7.7.