RavenDB文档数据库的HTTP API介绍

jieforest

Time for action – performing a GET request

You will learn to create a GET request using the RESTClient tool we have downloaded in the previous section to retrieve the document with the ID = Orders/A655302 from the Orders database and view it. (We created the Orders database in Chapter 2, RavenDB Management Studio.)

1）If it is not already open, double-click on the RESTClient tool's JAR file in order to launch it.

2）Click on the Method tab and select the GET HTTP method.

3）In the HTTP Request section, enter this URL: http://localhost:8080/databases/orders/docs/orders/a655302.

jieforest

Note

To perform this GET request, we don't need to change any of the Header or the Body, or other parameters.

4）Click on the green Go! button to send your first request to the server.

What just happened?

You just created your first GET request to retrieve the order document with the ID Orders/A655302 from the Orders database directly by using the RavenDB HTTP API.

Let's have a look at the server response and analyze it. The first thing that we need to check when we receive an HTTP response from the server is the status code. In case of a GET request, receiving an HTTP/1.1 200 OK code indicates that the request has succeeded. Otherwise there is an error and the server has not received, understood, or has not accepted the request.

jieforest

Select the Headers tab in the HTTP Response section and look to the header's data which came with the server response. We can see the RavenDB metadata Raven-Entity-Name from which the document has been retrieved.

Click on the Body tab to show the response body and you will see what the server sent back is a JSON document which is the actual JSON data document stored on the RavenDB server (which you can see using the Management Studio).

You just created your first GET request to retrieve the order document with the ID Orders/A655302 from the Orders database directly by using the RavenDB HTTP API.

Let's have a look at the server response and analyze it. The first thing that we need to check when we receive an HTTP response from the server is the status code. In case of a GET request, receiving an HTTP/1.1 200 OK code indicates that the request has succeeded. Otherwise there is an error and the server has not received, understood, or has not accepted the request.

jieforest

Select the Headers tab in the HTTP Response section and look to the header's data which came with the server response. We can see the RavenDB metadata Raven-Entity-Name from which the document has been retrieved.

Click on the Body tab to show the response body and you will see what the server sent back is a JSON document which is the actual JSON data document stored on the RavenDB server (which you can see using the Management Studio).

jieforest

You see how simple it was to get a document from RavenDB server using the HTTP API. We can basically get any document from the RavenDB server using the same approach.

Have a go hero – retrieving the databases list

You now know how to get any document from the RavenDB server using the HTTP API. Open the RESTClient tool and by using a GET HTTP method retrieve the databases' list from the server and compare it with the list you see when you open the Management Studio.

Need a hint? Use the RavenDB regular URL and the databases endpoint.