rest-easy-loki

REST-EASY-LOKI

A simple REST interface for the in-memory database, lokijs, featuring:

• Get an overview of all collections: https://localhost:3000/collections.
• Get all messages in a collection: https://localhost:3000/COLLECTION_NAME.
  • Pagination of messages in a collection: https://localhost:3000/COLLECTION_NAME?from=0&to=10.
  • Query a collection using find, for example based on strict equality q={"name": "a name"}: https://localhost:3000/COLLECTION_NAME?from=0&to=10&q=%7B%20%22name%22:%20%22My%20third%20lesson%22%20%7D
  • Another query example, not equal q={"name": {"$ne": "a name"}}: https://localhost:3000/COLLECTION_NAME?from=0&to=10&q=%7B%20%22name%22:%20%7B%20%22$ne%22:%20%22My%20third%20lesson%22%20%7D%7D.
• Create a new item: POST the item as an application/json body to https://localhost:3000/COLLECTION_NAME.
• Get the item with $loki ID: https://localhost:3000/COLLECTION_NAME/ID.
• Delete the item with $loki ID: Make a DELETE request to https://localhost:3000/COLLECTION_NAME/ID.
• Update the item by ID. PUT the item as an application/json body to https://localhost:3000/COLLECTION_NAME/ID. Alternatively, change the original item (from the GET, so including $loki ID) and PUT it back to https://localhost:3000/COLLECTION_NAME
• Automatic creation of new collections: when you post a message to a non-existing collection, it is automatically created.
• You can filter the properties that get returned (simple GraphQL-like filter) using a collection's 'view', e.g. http://localhost:3000/COLLECTION_NAME/view?props=title,$loki,file.
• You can use the public folder for sharing static files.
• You can require it in your own project.
• Reads .env file for specifying the database name, port, CORS and message size limits.

Installation

npm install
npm start # Will transpile the TypeScript project to JavaScript and run node on every change.

Usage

To simply run the lokijs server and expose the CRUD services.

npm run serve

To embed it in your own project, do something like the following:

import { createApi, db } from 'rest-easy-loki';

export const collectionName = 'documents';

export const startService = (done: () => void) => {
  db.startDatabase('my_database_file.json', () => {
    const api = createApi({ cors: true });
    api.listen(options.port).on('listening', () => {
      const exists = db.collections().reduce((acc, cur) => acc || cur.name === collectionName, false);
      if (!exists) {
        db.createCollection(collectionName, ['file']);
      }
      console.info(`Server running on port ${options.port}.`);
      done();
    });
  });
};