administrator, editor
31
edits
Changes
Jump to navigation
Jump to search
m
The root URL lists all available databases. The following examples assume thatyou have created a database instance from the [https:<code>http://files.basex.orglocalhost:8080/xmlrest</factbook.xml factbook.xml] document:code>
:<code>http://localhost:8984/rest</code> <syntaxhighlight pre lang="xml"><databases resources="1" xmlns="http://basex.org/rest"> <database resources="125742" size="181359943813599">factbookarticles</database> ...
If a resource is not found, an HTTP response will be generated with :<code>404http://localhost:8080/rest/articles/1973-02-08-xltp325.xml</code> as status code.
* Return the first five city names of the <b>factbook</b> Create an empty database and return databaseinformation: <syntaxhighlight pre lang="xml"><rest:query xmlns:rest="http://basex.org/rest"commands> <rest:text><![CDATA[ (//city/create-db name)[position() <= 5] ]]'db'/> <info-db/rest:text></rest:querycommands></syntaxhighlightpre>
* Return the first five city names of the <b>factbook</b> database: <pre lang="xml"><rest xmlns="http://basex.org/rest"> <rest><![CDATA[ (//city/name)[position() <= 5] ]]></text></rest></pre> Return string lengths of all text nodes that are found in the node that has been specified as initial context node: <syntaxhighlight pre lang="xml">
* Return the registered database users encoded in <code>ISO-8859-1</code>:<syntaxhighlight pre lang="xml">
* Create a new database from the specified input and preserve all whitespaces:<syntaxhighlight pre lang="xml">
* Bind value to the {{Code|$person}} variable and run query <code>find-person.xq</code>, which must be located in the directory specified by {{Option|WEBPATH}}:<syntaxhighlight pre lang="xml">
Have Take a look at the [[REST#Usage Examples|usage examples]] for more detailed examples using Java and shell tools like cURL.
All query Query parameters that have not been processed before otherwise will be treated as variable assignments:
* The following request assigns two variables to a server-side query file <code>mult.xq</code> placed in the HTTP directory:<br/><code>http://localhost:89848080/rest?run=mult.xqmultiply&$a=21&$b=2</code>assigns two variables and invokes <code>multiply.xq</code>:<syntaxhighlight pre lang="'xquery"'>(: XQuery file: multmultiply.xq :)
no edit summary
This page presents one of the [[Web Application]] services. It describes how to use the REST API of BaseX.
BaseX offers a RESTful API for accessing database resources via URLs.REST ([https://en.wikipedia.org/wiki/Representational_State_Transfer REpresentational State Transfer])facilitates a simple and fast access to databases through HTTP. The HTTP methodsGET, PUT, DELETE, and POST can be used to interact with the database.
=Usage=
By default, REST services are available at {{Code|http://localhost:89848080/rest/}}. If no default credentials are specified in the URL or when starting the web application, they will be requested by the client ([[Web Application#User Management|see further]]).
A web browser can be used to perform simple GET-based REST requests and display the response. Some alternatives for using REST are listed in the [[#Usage Examples|Usage Examples]].
Since BaseX 10, results in the {{Code|rest}} namespace are returned unprefixed:
<pre lang="xml">
<!-- before -->
<rest:databases xmlns:rest="http://basex.org/rest"/>
<!-- BaseX 10 -->
<databases xmlns="http://basex.org/rest"/>
</pre>
=URL Architecture=
A request to the root URL returns all available databases:
</databases>
</syntaxhighlightpre>
The resources of a database can be (directories, resource metadata) are listed by specifying the if a database, and potential sub directories, in the URL.In the given example, a single XML document an optional directory path is stored in the ''factbook'' databasespecified:
:<code>http://localhost:89848080/rest/factbookarticles</code>
<syntaxhighlight pre lang="xml"><database name="factbook" resources="1articles" xmlns:rest="http://basex.org/rest"> <dir>binaries</dir> <resource type="xml" content-type="application/xml" size="77192">factbook1973-02-08-xltp325.xml</resource> ...
</database>
</syntaxhighlightpre> The contents of If the path to a database can be retrieved by directly addressing single resource is specified, the resourceitself will be returned: :<code>http://localhost:8984/rest/factbook/factbook.xml</code>
==Parameters==
==GET Method==
If the GET method is used, all query parameters are directly specified within the URL.Additionally, the following '''operations''' can be specified:
* {{Code|query}}: Evaluate an XQuery expression. If a database or database path is specified in the URL, it is set as query context.
* {{Code|command}}: Execute a single [[Commands|database command]].
* {{Code|run}}: Evaluate an XQuery file or command script located on the server. The file path is resolved against the directory specified by {{Option|RESTPATH}} (before, it was resolved against {{Option|WEBPATH}})directory. Similar to {{Code|query}}, a database or database path is set as context. With {{Announce|Version 11}}, if no file is found and if the file suffix has been omitted, the extensions {{Code|.xq}} and {{Code|.bxs}} are successively attached to the supplied filename.
; Examples
* Lists all resources found in the '''tmp''' path of the ''factbook'' database:<br/><code>http://localhost:89848080/rest/factbook/tmp</code> * Returns the number of documents in a databasecalled ''test'':<br/><code>http://localhost:89848080/rest/databasetest?query=count(.)</code> * Serializes a document as JSONMLJsonML:<br/><code>http://localhost:89848080/rest/factbook/factbook.xml?method=json&json=format=jsonml</code> * <code>US-ASCII</code> is chosen as output encoding, and the query <code>eval.xq</code> is evaluated:<br/><code>http://localhost:89848080/rest?run=eval.xq&encoding=US-ASCII</code> * The next URL lists all database users that who are known to BaseX:<br/><code>http://localhost:89848080/rest?command=show+users</code>
==POST Method==
* {{Code|command}}: Execute single command
The root element may be bound to the optional REST namespace. Existing command scripts can be sent to the server without any modifications: * Create an empty database and return database information: <syntaxhighlight lang="xml"><commands> <create-db name='db'/> <info-db/></commands></syntaxhighlight>.
For the other commands, the following child elements are supported:
; Examples
<query>
<text>for $i in .//text() return string-length($i)</text>
</context>
</query>
</syntaxhighlightpre> Return the registered database users encoded in <code>ISO-8859-1</code>:
<command>
<text>show users</text>
<parameter name='encoding' value='ISO-8859-1'/>
</command>
</syntaxhighlightpre> Create a new database from the specified input and preserve all whitespaces:
<command>
<text>create db test http://files.basex.org/xml/xmark.xml</text>
<option name='chop' value='false'/>
</command>
</syntaxhighlightpre> Bind value to the {{Code|$person}} variable and run query <code>find-person.xq</code>:
<run>
<variable name='person' value='Johannes Müller'/>
<text>find-person.xq</text>
</run>
</syntaxhighlightpre>
==PUT Method==
; Examples
* A new database with the name <b>XMark</b> is created. If XML input is sent in the HTTP body, the resulting database resource will be called <b>XMark.xml</b>:<br/><code><nowiki>http://localhost:89848080/rest/XMark</nowiki></code>* A new database is created, and no whitespaces will be removed from the passed on XML input:<br/><code><nowiki>http://localhost:89848080/rest/XMark?chop=false</nowiki></code>* The contents of the HTTP body will be taken as input for the document <b>one.xml</b>, which will be stored in the <b>XMark</b> database:<br/><code><nowiki>http://localhost:89848080/rest/XMark/one.xml</nowiki></code>
An HTTP response with status code <code>201</code> (CREATED)is sent back if the operation was successful. Otherwise,the server will reply with <code>404</code> (if a specifieddatabase was not found) or <code>400</code> (if the operationcould not be completed).
==DELETE Method==
The DELETE method is used to delete databases or resources within a database.
; ExampleExamples* The <b>factbook</b> database is deleted:<br/><code><nowiki>http://localhost:89848080/rest/factbook</nowiki></code>* All resources of the <b>XMark</b> database are deleted that reside in the <b>tmp</b> path:<br/><code><nowiki>http://localhost:89848080/rest/XMark/tmp/</nowiki></code>
The HTTP status code <code>404</code> is returned if no database is specified.
==GET Method==
; Example
declare variable $a as xs:integer external;
declare variable $b as xs:integer external;
<mult>{ $a * $b }</mult>
</syntaxhighlightpre> ; Example {{Announce|Updated with Version 11:}} Support for multiple values. The request <code>http://localhost:8080/rest?run=sum&n=3&n=4&n=5</code> assigns multiple values to the same variable:<pre lang='xquery'>(: XQuery file: sum.xq :)declare variable $n as xs:integer* external;sum($n)</pre>
The dollar sign can be omitted as long as the variable name does not equal a parameter keyword (e.g.: <code>method</code>).
==POST Method==
If <code>query</code> or <code>run</code> is used as an operation, external variables can be specified via the <code><variable/></code> element:
<syntaxhighlight pre lang="xml">
<query xmlns="http://basex.org/rest">
<text><![CDATA[
<variable name="b" value="2"/>
</query>
</syntaxhighlightpre>
=Response=
The following three example requests all return <code><a/></code> with <code>application/xml</code> as content-type:
:<code>http://localhost:89848080/rest?query=%3Ca/%3E</code><br/><code>http://localhost:89848080/rest?query=%3Ca/%3E&method=xml</code><br/><code>http://localhost:89848080/rest?query=%3Ca/%3E&media-type=application/xml</code>
=Usage Examples=
<code>org.basex.util.Base64</code> can be used for that purpose:
<syntaxhighlight pre lang="java">
import java.net.*;
import org.basex.util.*;
public static void main(String[] args) throws Exception {
// The java URL connection to the resource.
URL url = new URL("http://localhost:89848080/rest/factbook");
// Establish the connection to the URL.
String user = "bob";
String pw ="alice";
// Encode user name username and password pair with a base64 implementation.
String encoded = Base64.encode(user + ":" + pw);
// Basic access authentication header to connection request.
}
}
</syntaxhighlightpre>
===Content-Types===
the connection (in this example we explicitly store the input file as raw):
<syntaxhighlight pre lang="java">
// store input as raw
conn.setRequestProperty("Content-Type", "application/octet-stream");
</syntaxhighlightpre>
See the [[REST#PUT Requests|PUT Requests]] section for a description of the possible content-types.
;GET
* <code><nowiki>curl -i "http://localhost:89848080/rest/factbook?query=//city/name"</nowiki></code>
;POST
* <code><nowiki>curl -i -X POST -H "Content-Type: application/xml" -d "<query xmlns='http://basex.org/rest'><text>//city/name</text></query>" "http://localhost:89848080/rest/factbook"</nowiki></code>* <code><nowiki>curl -i -X POST -H "Content-Type: application/xml" -T query.xml "http://localhost:89848080/rest/factbook"</nowiki></code>
;PUT
* <code><nowiki>curl -i -X PUT -T "etc/xml/factbook.xml" "http://localhost:89848080/rest/factbook"</nowiki></code>* <code><nowiki>curl -i -X PUT -H "Content-Type: application/json" -T "plain.json" "http://localhost:89848080/rest/plain"</nowiki></code>
;DELETE
* <code><nowiki>curl -i -X DELETE "http://admin:admin@localhost:89848080/rest/factbook"</nowiki></code>
=Changelog=
;Version 11.0
* Updated: [[#Request|Request]]: The extensions {{Code|.xq}} and {{Code|.bxs}} are successively attached to the supplied filename.
* Updated: [[#Assigning Variables|Assigning Variables]]: Support for multiple values.
;Version 10.0
* Updated: Results in the {{Code|rest}} namespace will be returned unprefixed.
* Updated: {{Code|dir}} elements are returned when listing the contents of a database.
;Version 9.0
