Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
m (Text replace - "assigned to the \{\{Code\|([^}]*)\}\} namespace" to "assigned to the <code><nowiki>$1</nowiki></code> namespace") |
|||
Line 9: | Line 9: | ||
... | ... | ||
</pre> | </pre> | ||
− | * In this documentation, the namespace is bound to the {{Code|rest}} prefix, and the | + | * In this documentation, the namespace is bound to the {{Code|rest}} prefix, and 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, the error {{Error|BXSE0003|#Errors}} is raised. | * If any of the functions is called outside the servlet context, the error {{Error|BXSE0003|#Errors}} is raised. | ||
Revision as of 17:35, 7 April 2015
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.