Difference between revisions of "RESTXQ Module"

From BaseX Documentation
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 40: Line 40:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns a [http://www.w3.org/Submission/wadl WADL description] of all available REST services.
+
|Returns a [https://www.w3.org/Submission/wadl WADL description] of all available REST services.
 
|}
 
|}
  
 
==rest:init==
 
==rest:init==
 
{{Mark|Updated with Version 9.4:}} Argument added.
 
  
 
{| width='100%'
 
{| width='100%'

Latest revision as of 18:50, 18 November 2020

This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.

Conventions[edit]

  • 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 the rest prefix.
  • The http://wadl.dev.java.net/2009/02 namespace is bound to the wadl prefix.
  • If any of the functions is called outside the servlet context, basex:http is raised.

General Functions[edit]

rest:base-uri[edit]

Signatures rest:base-uri() as xs:anyURI
Summary Returns the implementation-defined base URI of the resource function.

rest:uri[edit]

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[edit]

Signatures rest:wadl() as element(wadl:application)
Summary Returns a WADL description of all available REST services.

rest:init[edit]

Signatures rest:init() as empty-sequence()
rest:init($update as xs:boolean) as 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 $update is enabled, the background caching behavior is simulated (see PARSERESTXQ): Only updated modules will be parsed.
  • This function should be called if new RESTXQ code is deployed at runtime.

Changelog[edit]

Version 9.4
Version 8.6

This module was introduced with Version 7.7.