MarkLogic Rewriter Endpoint Viewer
This is a Swagger-like viewer for MarkLogic rewriter.xml files.
To enable this, add the following to the project's rewriter.xml:
<match-method any-of="GET HEAD">
<match-path matches="^/?$">
<dispatch>/rewriter-viewer/default.xqy</dispatch>
</match-path>
</match-method>Note: You can change the path to anything that makes sense, e.g. ^/swagger/?$.
Note: This assumes that this project is located in a rewriter-viewer folder
of your application's app-server root. If this is different, edit the dispatch
path to point to the correct location.
Documenting The Rewriter XML
This endpoint viewer uses
Dublin Core Elements
in the dc (http://purl.org/dc/elements/1.1/) namespace to annotate the various
parts of the rewriter file. This section documents the supported annotations.
Documentation such as the description uses XHTML -- that is, HTML documentation in
the h (http://www.w3.org/1999/xhtml) namespace.
MarkLogic rewriter elements are in the r (http://marklogic.com/xdmp/rewriter)
namespace.
r:rewriter Documentation
This is the top-level documentation that is displayed at the top of the page. It is useful to give a high-level overview of the endpoints.
| Element | Type | Description |
|---|---|---|
dc:title |
text() |
The title of the rewriter file. |
dc:description |
XHTML | The top-level description. |
dc:rights |
text() |
The copyright statement for the rewriter endpoints. |
r:match-path Documentation
This is the documentation for the endpoints in the rewriter file.
| Element | Type | Description |
|---|---|---|
dc:title |
text() |
The name of the endpoint. |
dc:description |
XHTML | The description of the endpoint. |
For example:
<match-method any-of="GET HEAD">
<match-path matches="^/?$">
<dc:title>MarkLogic rewriter endpoint viewer</dc:title>
<dc:description>
<h:p>This page. Allows you to run the endpoint queries from a browser.</h:p>
</dc:description>
<dispatch>/rewriter-viewer/default.xqy</dispatch>
</match-path>
</match-method>License
Copyright (C) 2022 Reece H. Dunn
This project is licensed under the Apache 2.0 license.