Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
m (Text replace - "| width='90' | '''Signatures'''" to "| width='120' | '''Signatures'''") |
|||
Line 17: | Line 17: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|rest:base-uri||xs:anyURI}} | |{{Func|rest:base-uri||xs:anyURI}} | ||
|- | |- | ||
Line 27: | Line 27: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|rest:uri||xs:anyURI}} | |{{Func|rest:uri||xs:anyURI}} | ||
|- | |- | ||
Line 37: | Line 37: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|rest:wadl||element(wadl:application)}} | |{{Func|rest:wadl||element(wadl:application)}} | ||
|- | |- |
Revision as of 11:36, 14 June 2013
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
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 | This function returns the implementation defined base URI of the resource function. |
rest:uri
Signatures | rest: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.