Web Module

This XQuery Module provides convenience functions for building web applications with RESTXQ.

Conventions

All functions in this module are assigned to the http://basex.org/modules/web namespace, which is statically bound to the web prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.

Functions

web:content-type

Signatures	web:content-type($path as xs:string) as xs:string
Summary	Returns the content type of a path by analyzing its file suffix. application/octet-stream is returned if the file suffix is unknown.
Examples	web:content-type("sample.mp3") returns audio/mpeg

web:create-url

Signatures	web:create-url($url as xs:string, $parameters as map(*)) as xs:string
Summary	Creates a new URL from the specified $url string and the $parameters specified in a map. The keys and and values of the map entries will be converted to strings, URI-encoded, and appended to the url as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.
Examples	web:create-url('http://find.me', map { 'q': 'dog' }) returns http://find.me?q=dog web:create-url('search', map { 'year': (2000,2001), 'title':() }) returns search?year=2000&year=2001

web:redirect

Signatures	web:redirect($location as xs:string) as element(rest:response)
Summary	Creates a RESTXQ redirection to the specified location. Redirects will only work if no other items are returned.
Examples	The query web:redirect('/a/b') returns the following response element: <rest:response xmlns:rest="http://exquery.org/ns/restxq"> <http:response xmlns:http="http://expath.org/ns/http-client" status="302"> <http:header name="location" value="/a/b"/> </http:response> </rest:response>

Changelog

The module was introduced with Version 8.1.