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...") |
|||
| Line 14: | Line 14: | ||
=General Functions= | =General Functions= | ||
| − | == | + | ==rest:base-uri== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func| | + | |{{Func|rest:base-uri||xs:anyURI}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| Line 28: | Line 28: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func| | + | |{{Func|rest:base-uri||xs:anyURI}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| Line 34: | Line 34: | ||
|} | |} | ||
| − | == | + | ==rest:wadl== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func| | + | |{{Func|rest:wadl||element(wadl:application)}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| Line 46: | Line 46: | ||
=Changelog= | =Changelog= | ||
| − | This module was introduced with Version 7. | + | This module was introduced with Version 7.7. |
[[Category:XQuery]] | [[Category:XQuery]] | ||
Revision as of 13:59, 4 June 2013
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Contents
Conventions
- This module is included in the complete distributions (zip, exe, war) of BaseX.
- All functions are assigned to the
http://exquery.org/ns/restxqnamespace, which must be dynamically imported:
import module namespace rest = "http://exquery.org/ns/restxq"; ...
- In this documentation, the namespace is bound to the
restprefix, and thehttp://wadl.dev.java.net/2009/02namespace is bound to thewadlprefix. - 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 | This function returns the implementation defined base URI of the resource function. |
restxq:uri
| Signatures | rest:base-uri() as xs:anyURI
|
| Summary | This function 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 | This (unofficial) function returns a [WADL description] of all available REST services. |
Changelog
This module was introduced with Version 7.7.
