Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
m (Text replace - "\[\[Category:XQuery\]\]" to "") |
|||
Line 15: | Line 15: | ||
==rest:base-uri== | ==rest:base-uri== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 21: | Line 22: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Returns the implementation-defined base URI of the resource function. |
|} | |} | ||
==rest:uri== | ==rest:uri== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 31: | Line 33: | ||
|- | |- | ||
| '''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== | ==rest:wadl== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 41: | Line 44: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Returns a [http://www.w3.org/Submission/wadl WADL description] of all available REST services. |
+ | |} | ||
+ | |||
+ | ==rest:init== | ||
+ | |||
+ | {{Mark|Introduced with Version 8.6}}: | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|rest:init||empty-sequence()}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Initializes the RESTXQ module cache. This function should be called if {{Option|CACHERESTXQ}} is enabled and if RESTXQ functions have been replaced. | ||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 8.6 | ||
+ | * Added: [[#rest:init|rest:init]] | ||
This module was introduced with Version 7.7. | This module was introduced with Version 7.7. |
Revision as of 13:42, 7 July 2016
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Contents
Conventions
- The
basex-api
package must be included in the classpath. This is always the case if you use one of the complete distributions (zip, exe, war) of BaseX. - All functions are assigned to the
http://exquery.org/ns/restxq
namespace. The module must be imported in the query prolog:
import module namespace rest = "http://exquery.org/ns/restxq"; ...
- In this documentation, the namespace is bound to the
rest
prefix, and thehttp://wadl.dev.java.net/2009/02
namespace is bound to thewadl
prefix. - If any of the functions is called outside the servlet context, the error
BXSE0003
: 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()
|
Summary | Initializes the RESTXQ module cache. This function should be called if CACHERESTXQ is enabled and if RESTXQ functions have been replaced.
|
Changelog
- Version 8.6
- Added: rest:init
This module was introduced with Version 7.7.