all repos — litestore @ 2221204d6f84d20280020d51831f2a5d2c6b3ecf

A minimalist nosql document store.

src/admin/md/api.md

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 
## HTTP API Reference

LiteStore provides a RESTful HTTP API. At present, the only two resources exposed are the following:

* info – information about the data store (read-only)
* docs – LiteStore documents (read-write)

### Accessing LiteStore Resources

To access a LiteStore resource, use URLs composed in the following way:

`http:<hostname>:<port>/v<version>/<resource>/<id>`

Example: [localhost:9500/v2/docs/admin/index.html](http://localhost:9500/v2/docs/admin/index.html)

> %note%
> Remarks
>
> * If the version is omitted, the latest version of the LiteStore API will be used by default. The previous URL can be therefore written as <http://localhost:9500/docs/admin/index.html>.
> * In a somewhat non-standard way, IDs of LiteStore documents can contain slashes. The main reason behind this is that this makes it possible to implement a virtual file system with LiteStore easily, and serve up web pages as you would from an ordinary filesystem.