endpoint-js

1.0.10 • Public • Published

endpoint.js

Codacy Badge

NPM

Simplistic express routing management for NodeJS

  • Manage all endpoints in a structure file
  • Controller and routers folders and files are created automatically by route
  • Built in CLI for creating boilerplate and adding new endpoints
  • Automatically registers your (Endpoint | Router | Controller) with express

Install

CLI

$ npm install --global endpoint-js

endpoint.js

$ npm install --save endpoint-js

Usage

In your home directory create endpoint app boilerplate:

$ endpoint --i

And your api routing folder and ready!

To add an API route (Endpoint)

$ endpoint --a

fill in the prompt with your endpoint details, for example:

  • endpoint path: /api/is/awesome
  • router file name: awesome.js
  • controller file name: awesomeController.js

And an endpoint was added to Router.js (API structure file), foldering and file creation is done automatically!

In your index.js or wherever you create your express app, simply:

var app = express();
require('endpoint-js')(app);

OPTIONALS:

  • if you want all of your endpoint structure to have some predetermined prefix you can do so:
require('endpoint-js')(app, {prefix: "/someprefix"});
LICENCE & CREDITS

MIT © Elad Keyshawn

Package Sidebar

Install

npm i endpoint-js

Weekly Downloads

4

Version

1.0.10

License

MIT

Last publish

Collaborators

  • eladkeyshawn