RxApi DUMMY VERSION

Run the minimal API HTTP RESTFULL and WEBSOCKETS in memory database for make a fast dummy testing.

https://rxapi.js.gl

Install rxAPI from npm

sudo npm i rxapi -g

Create a dummy project

rxapi dummy project

Create a server project

rxapi new project

DOCUMENTATION FOR RXAPI DUMMY IN MEMORY:

http://rxapi.js.gl

Generate models schema in 'schema.json'

{
  "users": {
    "username" : "string",
    "surname" : "string",
    "password" : "string"
  },
  "articles": {
    "title" : "string",
    "creation" : "date",
    "tags" : "string",
    "content" : "text",
    "author" : "string"
  }
}

Generate HTTP RESTFULL scaffold in 'scaffold/http.js':

module.exports = api => {

  api.gen('articles')

}

Generate SOCKET.IO scaffold in 'scaffold/socket.js':

module.exports = api => {

  api.gen('articles' (socket, db) => {
    console.log('SOCKET Articles listening...')
  })

}

Run

npm start

HTTP API RESTFULL Routes

Articles demo:

HTTP Route	Verb	Description
/articles	GET	Get all articles
/articles	POST	Create a article
/articles/:article_id	GET	Get a single article
/articles/:article_id	PUT	Update a article with new info
/articles/:article_id	DELETE	Delete article

SOCKET.IO SCAFFOLD

Articles demo:

Emit and events	Description
articlesGetAll	Get all articles
articlesAdd	Create a article
articlesGet	Get a single article
articlesUpdate	Update a article with new info
articlesDelete	Delete article

Add fast features in HTTP with callback:

api.gen('users', (http, db) => {
  db.loadDatabase(err => {
    if (err) throw Error(`DB USER: Have a problem loading db ${err}`)
    else {
      db.insert({
        "username" : "user",
        "name" : "user_name",
        "surname" : "user_surname",
        "password" : "password"
      },
      (err, newDoc) => {
        if (err) throw Error(`DB USER: Have a problem inserting in db ${err}!`);
        else console.log(`DB USER: Default user created!`);
      })
    }
  })
})

Add fast features in SOCKET with callback:

api.gen('articles', (socket, db) => {
  db.find({ _id : FX8REOZyumD022XE }, (err, docs) => {
    if (err) console.error(`Error... ${err}`)
    else console.log(`Results: ${JSON.stringify(docs)}`)
  })
})

Dependencies thanks

• Express.js http://expressjs.com/
• Socket.io http://socket.io
• Body-parser https://github.com/expressjs/body-parser
• NeDB https://github.com/louischatriot/nedb

License

The MIT License (MIT) Copyright (c) 2016 Josep Subils Rigau (josep@js.gl)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.