Difference between revisions of "Web Module"
Line 97: | Line 97: | ||
==web:response-header== | ==web:response-header== | ||
+ | |||
+ | {{Mark|Updated with Version 8.4}}: `raw` method was removed. | ||
{| width='100%' | {| width='100%' | ||
Line 109: | Line 111: | ||
Serialization parameters can be supplied via the <code>$output</code> argument. Empty string values can be specified to invalidate default values. By default, the following serialization parameters will be returned: | Serialization parameters can be supplied via the <code>$output</code> argument. Empty string values can be specified to invalidate default values. By default, the following serialization parameters will be returned: | ||
* <code>media-type</code>: <code>application/octet-stream</code> | * <code>media-type</code>: <code>application/octet-stream</code> | ||
− | |||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 121: | Line 122: | ||
<output:serialization-parameters xmlns:output="http://www.w3.org/2010/xslt-xquery-serialization"> | <output:serialization-parameters xmlns:output="http://www.w3.org/2010/xslt-xquery-serialization"> | ||
<output:media-type value="application/octet-stream"/> | <output:media-type value="application/octet-stream"/> | ||
− | |||
</output:serialization-parameters> | </output:serialization-parameters> | ||
</rest:response> | </rest:response> | ||
Line 152: | Line 152: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 8.4 | ||
+ | |||
+ | * Updated: [[#web:response-header|web:response-header]]: `raw` method was removed. | ||
;Version 8.2 | ;Version 8.2 |
Revision as of 14:36, 18 November 2015
This XQuery Module provides convenience functions for building web applications with RESTXQ.
Contents
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:create-url
Signatures | web:create-url($url as xs:string, $parameters as map(item(), item()*)) 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, URL-encoded (see web:encode-url), 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:encode-url
Signatures | web:encode-url($string as xs:string) as xs:string |
Summary | Encodes a string to a URL. Spaces are rewritten to + ; * , - , . and _ are adopted; and all other non-ASCII characters and special characters are percent-encoded.
|
Examples |
|
web:decode-url
Signatures | web:decode-url($string as xs:string) as xs:string |
Summary | Decodes a URL to the original string. Percent-encoded characters are decoded to their UTF8 codepoints, and + characters are rewritten to spaces.
|
Examples |
|
Errors | BXWE0001 : Specified URI is invalid.
|
Errors | BXWE0002 : Specified URI contains invalid XML characters.
|
web:redirect
Signatures | web:redirect($location as xs:string) as element(rest:response) web:redirect($location as xs:string, $parameters as map(item(), item()*)) as element(rest:response) |
Summary | Creates a RESTXQ redirection to the specified location. The returned response will only work if no other items are returned by the RESTXQ function. If $parameters are specified, they will be appended as query parameters to the URL as described for web:create-url.
|
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> |
web:response-header
Template:Mark: `raw` method was removed.
Signatures | web:response-header() as element(rest:response) web:response-header($headers as map(*)) as element(rest:response) web:response-header($headers as map(*), $output as map(xs:string, xs:string)) as element(rest:response) |
Summary | Creates a RESTXQ response header with a default caching directive and default serialization parameters. Header options can be supplied via the
Serialization parameters can be supplied via the
|
Examples |
<rest:response xmlns:rest="http://exquery.org/ns/restxq"> <http:response xmlns:http="http://expath.org/ns/http-client"> <http:header name="Cache-Control" value="max-age=3600,public"/> </http:response> <output:serialization-parameters xmlns:output="http://www.w3.org/2010/xslt-xquery-serialization"> <output:media-type value="application/octet-stream"/> </output:serialization-parameters> </rest:response>
declare %rest:path('media/{$file}') function local:get($file) { let $path := 'path/to/' || $file return ( web:response-header(map { 'media-type': web:content-type($path) }), file:read-binary($path) ) }; …a file resource with the correct content-type will be returned to user (provided that it exists in the web server's file system). |
Errors
Code | Description |
---|---|
BXWE0001
|
Specified URL is invalid. |
BXWE0002
|
Specified URL contains invalid XML characters. |
Changelog
- Version 8.4
- Updated: web:response-header: `raw` method was removed.
- Version 8.2
- Added: web:encode-url, web:decode-url
The module was introduced with Version 8.1.