koa-mongo-router v0.4.146

KOA REST API Router for MongoDB

A router that exposes a standard REST API for a MongoDB

Status: BETA

1. Usage
2. Mongo Routes
3. Query String

Usage

npm install koa-mongo-router

import { getDatabaseRouter } from 'koa-mongo-router'
import { IDatabaseRouterOptions } from 'koa-mongo-router/lib/database-router-options'

const databaseRouterOptions: IDatabaseRouterOptions = {
    permissionCheck: async (
        ctx: Koa.Context,
        next: () => Promise<any>,
        database: string,
        collection: string
    ) => {
        // Assumes you have middleware that already adds a user
        if (ctx.state.user == undefined) {
            ctx.status = 401
            return
        }

        // Example of validating if a user has read or write permissions
        switch (ctx.Method) {
            case "GET":
                if (!ctx.state.user.canRead(database, collection)) {
                    ctx.status = 403
                    return
                }
                break

            case "PUT":
            case "POST":
            case "PATCH":
            case "DELETE":
                if (!ctx.state.user.canWrite(database, collection)) {
                    ctx.status = 403
                    return
                }
                break
        }

        // If user haas permission for method, then continue on
        await next()
    }
};

const mongoRouter = getDatabaseRouter(databaseRouterOptions)

const app = new Koa()
    .use(mongoRouter.routes())
    .use(mongoRouter.allowedMethods())

Mongo Routes

Get Items

Get items from a collection. Items can be filtered, paged, sorted, and counted using query string parameters.

Create An Item

Create a new item. This creates a new _id and assigns it to the item.

Create Or Replace Items

Create or replace items.

Update Items

Update items.

Delete Items

Delete items.

Get An Item

Get an item.

Get Or Replace An Item

Get or replace an item.

Update An Item

Update an item.

Delete An Item

Delete an item.

Query String

Query String Options

Query String Filtering