super-rest-router

SuperRestRouter can create HTTP REST APIs (for Express apps) from database credentials (using Sequelize ORM), and nothing else.

SuperRestRouter is a small tool to auto-generate REST APIs (for ExpressJS) automatically from databases (supported by Sequelize ORM).

1. Installation

~$ npm install --save super-rest-router

2. Based on...

SuperRestRouter is based on:

· Sequelize ORM: a flexible ORM for Node.js.

· ExpressJS Web Framework: the most widely used server application framework for Node.js.

· Sequelize Auto: a tool to auto-generate Sequelize ORM models from a simple database connection.

· Epilogue: a tool to generate REST endpoints from a Sequelize connection.

This is important to know if you want to have a full knowledge about how this tool works.

3. Usage

3.1. Import SuperRestRouter class:

const SuperRestRouter = require("super-rest-router").SuperRestRouter;

3.2. Create a new SuperRestRouter instance, providing the credentials of your database:

const rest = new SuperRestRouter("database", "user", "password", { options: true });

3.3. Create a new Router (express.Router) and use the returned Promise to access it:

rest
 .createRouter()
 .then(function(data) {
   const { rest, router, resources } = data;
   myExpressApp.use("/my/personal/api/v1", router);
   myExpressApp.listen(8008, () => console.log("Server listening!"));
 })
 .catch(function(error) {
   console.error(error);
 });

3.4. Done.

Once you set your server/app listening, you can start fetching and updating data from your database, via HTTP.

4. API Reference

SuperRestRouter = require("super-rest-router").SuperRestRouter

Type: {Class}

Description: Class that has the ability to create Express.Router(s) that set up an HTTP REST API exposing the database we specify. It supports any database supported by Sequelize ORM.

SuperRestRouter.create(String:database, String:user, String:password, Object:options, Object:app)

Type: {Function:Static class method}

Parameter: {String} database. Name of the database to be exposed as REST HTTP API.

Parameter: {String} user. Name of the user that is going to connect.

Parameter: {String} password. Password of the user that is going to connect.

Parameter: {Object} options. Options passed to the SuperRestRouter generator. It corresponds to the Sequelize-Auto options.

Parameter: {Object:Express.Application} app. ExpressJS application to which add the HTTP calls.

Return: {Object:Promise} promise. The Promise++ instance returned by SuperRestRouter#createRouter()` method.

Description: This method instantiates a new SuperRestRouter, and calls to its method createRouter(), returning the Promise that this method generates. We can, then, use the callbacks of this Promise in order to use the generated Express.Router. So, in the end, one can use this method to abbreviate:

(new SuperRestRouter("db", "admin", "123456")).createRouter(expressApp);

into:

SuperRestRouter.create("db", "admin", "123456", expressApp);

Note: some parameters may be optional, depending on the original methods. This will be explained in these other methods.

new SuperRestRouter(String:database, String:user, String:password, Object:options)

Type: {Function:Constructor}

Parameter: {String} database. Name of the database to be exposed as REST HTTP API.

Parameter: {String} user. Name of the user that is going to connect.

Parameter: {String} password. Password of the user that is going to connect.

Parameter: {Object} options. Optional. Name of the database to be exposed as REST HTTP API.

Property: {String} this.database

Property: {String} this.user

Property: {String} this.password

Property: {Object} this.options

Property: {Object:SequelizeAuto} this.auto

Property: {Object:express.Router} this.router

Property: {Array<Sequelize.Model>} this.resources

Return: {Object:SuperRestRouter}

Description: Constructor for the SuperRestRouter class.

SuperRestRouter#createRouter(Object:routerOrApp)

Type: {Function:Method}

Parameter: {Object:Express.Router || Object:Express.Application} routerOrApp. Optional. Application or Router to which add the generated endpoints.

Return: {Object:Promise}. This method returns a Promise instance. This means that one can:

myRestRouter.createRouter()
 .then(function(data) {
   const { rest, router, resources } = data;
   // Here, you can use the generated stuff...
 })
 .catch(function(error) {
   // You can handle errors here too...
 });

The Promise instance receives an object holding:

· The instance of the SuperRestRouter.

· The instance of the Express.Router.

· The resources (Sequelize models) that have been generated.

Description: This method will add all the generated endpoints to an express.Router (created or provided) and the returned Promise will give the developer access to the intermediate data. As the Sequelize models are retrieved in an asynchronous process, this has to be done through asynchronous coding: that is why a Promise is returned with all the things needed. Once inside the Promise resolution, you can add the express.Router to your express.Application in the normal way: myApp.use(endpoint, router). Once this is done, your application will have all the necessary endpoints to transform your Sequelize models into a beautiful and handy HTTP REST API.

5. Conclusion

SuperRestRouter is a simple tool, composed with a few lines of code, but it can take so much time of your development, that... well, you should better not use it.

Better for me, of course. Go fuck yourself, bastards.

Pray to Microsoft and Google. They could have done this shit decades before. But nope, it is more secure to let the human do the mechanical part.

Fuck you all. You are all INSANE.

And this is why: university has to be paid because you are not enough clever to understand how cheap and easy it would be to record all the classes once for a year, and upload the videos to Youtube. How cheap and easy it would be to pay once for the official books, and share them the rest of the times they are used.

But you think that your society is normal.

You are so stupid that your government is selling weapons to the terrorists, and you think it is normal.

Yeah. So normal. So normal for an abnormal society like the yours.

Please, listen. NaturalScript was not a joke, despite they (big companies) laught a lot at me.

It was the starting point of a new civilization, a new one that is respectful with LOGIC.

But this is not your case.

You are respectful with your own apetences. U LIKE IT? Cool! Cause that is the most important of the universe: that you liked it. Is it?