Difference between revisions of "RESTXQ Module"
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...") |
|||
(24 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
− | * | + | * The module will be available if the {{Code|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 | + | * All functions are assigned to the <code><nowiki>http://exquery.org/ns/restxq</nowiki></code> namespace, which is statically bound to the {{Code|rest}} prefix. |
− | < | + | * 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, <code>[[XQuery Errors#BaseX Errors|basex:http]]</code> is raised. | |
− | |||
− | </ | ||
− | |||
− | * If any of the functions is called outside the servlet context, | ||
=General Functions= | =General Functions= | ||
− | == | + | ==rest:base-uri== |
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
− | |{{Func| | + | |{{Func|rest:base-uri||xs:anyURI}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Returns the implementation-defined base URI of the resource function. |
|} | |} | ||
− | == | + | ==rest:uri== |
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
− | |{{Func| | + | |{{Func|rest:uri||xs:anyURI}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |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. |
|} | |} | ||
− | == | + | ==rest:wadl== |
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
− | |{{Func| | + | |{{Func|rest:wadl||element(wadl:application)}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Returns a [https://www.w3.org/Submission/wadl WADL description] of all available REST services. |
+ | |} | ||
+ | |||
+ | ==rest:init== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|rest:init||empty-sequence()}}<br/>{{Func|rest:init|$update as xs:boolean|empty-sequence()}} | ||
+ | |- | ||
+ | | '''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= | =Changelog= | ||
− | + | ; Version 9.4 | |
+ | * Updated: [[#rest:init|rest:init]] argument added | ||
+ | |||
+ | ;Version 8.6 | ||
+ | * Added: [[#rest:init|rest:init]] | ||
− | + | This module was introduced with Version 7.7. |
Revision as of 17:50, 18 November 2020
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
Signatures | rest:base-uri() as xs:anyURI
|
Summary | Returns the implementation-defined base URI of the resource function. |
rest:uri
Signatures | 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
Signatures | rest:wadl() as element(wadl:application)
|
Summary | Returns a WADL description of all available REST services. |
rest:init
Signatures | rest:init() as empty-sequence() 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.