Skip to content
Automatic Mongoose REST API - API Consumption Module ☕
JavaScript CoffeeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
js
src
.editorconfig
.gitignore
.travis.yml
Gruntfile.coffee
README.md
package-lock.json
package.json

README.md

Mongoose Auto API - API Consumption Module

Build Status npm version

Automatic Mongoose REST API - Rest API Module ☕

Install

  • npm i -S mongoose-auto-api.consumer

Model Setup

Usage

$ consumer = require('mongoose-auto-api.consumer')

Methods

  • URL Attribute i.e. consumer.url
    • Gets API url
  • Port Attribute i.e. consumer.port
    • Gets API port
  • setPort
    • sets server port for requests
    • parm - port (Number)
  • setAuthToken
    • sets auth token for requests
    • parm - authToken (str)
  • Collection methods
    • parms - collection (str), args (obj)
    • insert -> /collection/insert
    • update -> /collection/update
    • remove -> /collection/delete
    • removeAll -> /collection/delete_all
    • get -> /collection/get
    • getAll -> /collection/get_all
    • find -> /collection/find
    • schemaInfo -> /collection/schema
    • sterilize -> /collection/sterilize
    • updatePush -> /collection/push
    • updatePushUnique -> /collection/push_unique
    • updateSet -> /collection/set
  • Auth methods
    • parms - args (obj)
      • args are url query parameters, see Rest API link above for query parameters
    • setSecretKey -> /update_secret_key
    • login -> /login
    • signup -> /signup
    • updatePassword -> /update_password
    • verifyToken -> /verify_token
You can’t perform that action at this time.