build-express-api1.0.5 • Public • Published
Build Express Api
A Command line interface for instantly building an express rest api.
Create controllers, models and add routes in matter of seconds.
This CLI only supports Node 6 and over.
- Getting Started
- Creating a new controller
- Adding routes to a controller
- Creating new model
Install it once globally:
$ npm install -g build-express-api
Initializing the application structure
$ mkdir my-app$ cd my-app$ build-express-api init
my-app ├── package.json ├── rest └── controllers └── models └── server.js
Install all the needed dependencies:
$ npm install
Note: when running all of the further commands, please stay in the my-app directory
Creating a new controller
$ build-express-api create-controller
The CLI will now take you through series of questions, the example of building a new controller would be:
You can choose the plain controller or custom routes controller from the menu.
Plain controller just creates a controller with built in routes in rest/controllers/controllerName.js.
Custom routes controller allows you to manually add your routes, the example of building custom routes controller would be:
Note: make sure that you write the routes in the correct (strict JSON) format such as:
When the controller is created it will automatically be imported in server.js file
Adding routes to a controller
$ build-express-api add-routes <controllerName>
Creating new model
$ build-express-api create-model
Note: When creating new model, you don't need to provide the properties in strict JSON format, just separate them with the comma
Also models are not automatically imported in server.js, so you will need to import them manually.
This CLI supports only mongoose models for now.
Note: The experience this CLI provides does not work as smooth in Git Bash terminal, since it is not an interactive terminal, but if you are using Git Bash inside VS Code, then there are no problems, I found no complications using any other terminal.