Sample RestXQ

100%

✓ Published0🌍 Public

Last edited Feb 23, 2018

Created on Feb 23, 2018

This example demonstrates how to route HTTP requests and return XML responses using the RESTXQ API in BaseX. It defines multiple endpoint paths, including dynamic segments like `hello/{$who}` and `post/{$post}`, alongside static routes for the root and about pages. A custom error handler returns a 404 status with an HTML page when a requested path does not match any defined route. The code imports a separate model module that provides a `say-hello` function, which is called by the hello endpoint to generate XML output.

AI-generated description

Similar vizzes

Loading thumbnail…

Error 404

This example demonstrates a RESTful API built with BaseX and XQuery, returning dynamic XML responses for various routes, including a custom 404 error page. It shows how URL path parameters and HTTP status codes are handled through the `%rest:path` and `%rest:GET` annotations, with a fallback error handler that issues a 404 status. The code uses the `rest` and `http` output serialization, while the model and view modules (model.xqm and view.xqm) separate data retrieval—querying ORCID person names—from presentation, rendering lists as HTML paragraphs. No client-side visualization libraries are involved; the focus is on server-side routing and structured data delivery.

CCliffordAnderson

82% match

Loading thumbnail…

Hello { $who }!

This example demonstrates a simple RESTful API that returns an XML response containing a personalized greeting. It uses the BaseX RESTXQ module, declaring a function with the `%rest:path` and `%rest:GET` annotations to handle HTTP GET requests. The path pattern `hello/{$who}` captures a URL segment into the `$who` variable, which is then interpolated into the `<title>` element of the `<response>` document. The code shows how a single annotated function can expose a dynamic endpoint without additional routing logic.

CCliffordAnderson

77% match

Loading thumbnail…

Hello { $who }!

This example demonstrates a minimal RESTXQ service that responds to an HTTP GET request with a personalized XML greeting. It defines a single endpoint that captures a URL path segment as the `$who` variable and returns a `<response>` element containing a `<title>` with the greeting text. The code uses the `rest:path` and `rest:GET` annotations from the BaseX RESTXQ API to bind the route, and it is written in XQuery 3.1 within a module namespace. No additional visualization or rendering libraries are involved; the output is plain XML data.

CCliffordAnderson

77% match

Loading thumbnail…

BaseX Server

This example shows a minimal RESTful web application built with BaseX, a native XML database, that serves XHTML pages for a poetry corpus. The code defines four GET endpoints—root, `/about`, `/credits`, and `/poem/{name}`—each returning a simple HTML page via the `view:display-contents` function. The implementation uses BaseX’s RESTXQ annotations (`%rest:path`, `%rest:GET`) and XQuery modules (`api.xqm`, `model.xqm`, `view.xqm`). The `model:credits` function supplies static HTML content, while the view module constructs the page skeleton. Data is hardcoded in XQuery, with no external datasets or JavaScript libraries involved.

CCliffordAnderson

75% match

Loading thumbnail…

{$title}

This example demonstrates a minimal XQuery web application for the Corpus Baudelaire project, serving static XHTML pages and dynamic poem routes. It shows how RESTXQ annotations declare endpoints for the root path, an about page, a credits page, and a parameterized poem URL, with each route returning a simple HTML document via a shared display function. The code relies on the RESTXQ API for request routing and the XQuery standard library for string concatenation and element construction, though it renders no actual data visualization.

CCliffordAnderson

74% match

Loading thumbnail…

Experiments with XQuery, RESTXQ, and MVC in BaseX

This example demonstrates a model-view-controller (MVC) architecture for serving a web-based corpus of Charles Baudelaire’s poems, with XQuery functions defining RESTful routes. It shows how BaseX’s RESTXQ annotations (`%rest:path`, `%rest:GET`) map URLs like `/`, `/about`, and `/contents` to controller functions, while a separate view module generates XHTML pages with Bootstrap styling. The model module queries the `fleurs-du-mal` collection to extract contributor names and poem titles for dynamic content. The code highlights XQuery’s role in both server-side logic and HTML templating, without any client-side JavaScript or charting libraries.

CCliffordAnderson

74% match

Loading thumbnail…

RESTXQ example using map:find with BaseX 6.0 beta

This example demonstrates a RESTXQ service that queries the Open Library API for book titles and returns matching results as XML. The code defines an XQuery function annotated with `%rest:path` and `%rest:GET`, which receives a book title and a key parameter. It constructs a URL to the Open Library search endpoint, retrieves the JSON response using `fn:json-doc`, then flattens and searches the resulting structure with `array:flatten` and `map:find` from BaseX 6.0. The matched items are wrapped in a custom `results` element.

CCliffordAnderson

71% match

Loading thumbnail…

HTTP GET Request with eXistDB

This example demonstrates an HTTP GET request issued from within eXistDB using the XQuery `httpclient:get` function, targeting the URL `http://www.rest.com`. It shows how to fetch and parse an external resource by wrapping the response body as an XHTML fragment, specifically accessing the `/httpclient:body/html` path. The code relies on the eXist-dB HTTP Client module, which handles the low-level transport and returns the response in a structured format. No external JavaScript libraries or rendering frameworks are involved; the focus is purely on server-side data retrieval and XML manipulation within the eXist-dB environment.

CCliffordAnderson

60% match