Difference between revisions of "Web Module"
Jump to navigation
Jump to search
| Line 57: | Line 57: | ||
</http:response> | </http:response> | ||
</rest:response> | </rest:response> | ||
| + | </pre> | ||
| + | |} | ||
| + | |||
| + | ==web:response-header== | ||
| + | |||
| + | {| width='100%' | ||
| + | |- | ||
| + | | width='120' | '''Signatures''' | ||
| + | |{{Func|web:response-header|$path as xs:string|element(rest:response)}}<br/> | ||
| + | |- | ||
| + | | '''Summary''' | ||
| + | |Creates a [[RESTXQ#Response|RESTXQ reponse header]] for the specified <code>$file</code> with the correct mime-type and some caching directives. The output will only be correctly evaluated if no other items are returned before the header. | ||
| + | |- | ||
| + | | '''Examples''' | ||
| + | |If the following RESTXQ function is called…<br/> | ||
| + | <pre class="brush:xquery"> | ||
| + | declare %rest:path('image/{$image}') function local:get($image) { | ||
| + | let $path := 'path/to/' || $image | ||
| + | return ( | ||
| + | web:response-header($path), | ||
| + | file:read-binary($path) | ||
| + | ) | ||
| + | }; | ||
| + | </pre> | ||
| + | …an image with the specified name (if available) will be sent back to the client:<br/> | ||
| + | <pre class="brush:xml"> | ||
| + | <rest:response xmlns:rest="http://exquery.org/ns/restxq"> | ||
| + | <http:response xmlns:http="http://expath.org/ns/http-client" status="302"> | ||
| + | <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="image/png"/> | ||
| + | <output:method value="raw"/> | ||
| + | </output:serialization-parameters> | ||
| + | </rest:response>, | ||
| + | ... | ||
</pre> | </pre> | ||
|} | |} | ||
Revision as of 15:47, 27 March 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(*)) 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: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>
|
web:response-header
| Signatures | web:response-header($path as xs:string) as element(rest:response) |
| Summary | Creates a RESTXQ reponse header for the specified $file with the correct mime-type and some caching directives. The output will only be correctly evaluated if no other items are returned before the header.
|
| Examples | If the following RESTXQ function is called…declare %rest:path('image/{$image}') function local:get($image) {
let $path := 'path/to/' || $image
return (
web:response-header($path),
file:read-binary($path)
)
};
…an image with the specified name (if available) will be sent back to the client: <rest:response xmlns:rest="http://exquery.org/ns/restxq">
<http:response xmlns:http="http://expath.org/ns/http-client" status="302">
<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="image/png"/>
<output:method value="raw"/>
</output:serialization-parameters>
</rest:response>,
...
|
Changelog
The module was introduced with Version 8.1.
