Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

koa-mongo-rest

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

koa-mongo-rest

generate REST API with koa and mongo

  • 0.1.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2
Maintainers
1
Weekly downloads
 
Created
Source

Koa mongo REST NPM version Dependency Status Build Status

Easy REST api for koa server

NPM

Installation

Install using npm:

npm install koa-mongo-rest

Usage

###Basic usage

Require library

var createModel = require('koa-mongo-rest');

Create schema

var schema = {
  schema: {
    email: String,
    name: String,
    password: String,
    address: String,
    zipcode: Number,
    lists: Array
  },
  collectionName: 'user', //this is required
  //mongoose schema options (optional)
  options: {
    versionKey: false
  }
};

Create server

var koa = require('koa');
var router = require('koa-router');

var mongoUrl = '127.0.0.1:27017'

var app = koa();

//router is required
app.use(router(app));

//create mongoose model
//you can use it to create custom actions
var model = app.model = createModel(schema, mongoUrl);

//add REST routes to your app. Prefix is optional
model.generateApi(app, '/api');

app.listen(process.env.PORT || 5000);

Live demo
App consuming api

Keywords

FAQs

Package last updated on 30 Mar 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc