node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

generator-restgoose

generator-restgoose Build Status npm version Join the chat at https://gitter.im/generator-restgoose/Lobby

Mongoose RESTful API generator for your NodeJS Express App v0.2.51

A custom-built Mongoose generator for Yeoman. The base project has been forked from afj176/generator-mongoose and has been updated with many new features, tests and tweaks to get you full fledged out-of-the-box NodeJS Express API Application up and running, Route vs Model Segregation and much more.

NPM

Minimum Node Version : 4.x
Minimum NPM Version : 3.x

Quick Links

If you would like to contribute, please refer to guidelines and a list of open tasks.

For more information, please refer to the Wiki page and FAQ

Overview

  • Scaffolds out-of-the-box REST API Server
  • FUll blow n ready to use Authentication and Authorization (Passport + JWT + Redis)
  • Generates All Ready to run files
    • Model ( Mongoose)
    • Api Route (endpoint)
    • Api Object (Business Layer, crud logic)
    • Documentation (API reffernce)
    • Test File
  • Generates ready-to-rock README file with License(MIT), etc.
  • Conforms to jSend Specs for API JSON Response
  • Modular and based on Seperation of Concern
  • Fast and readible code generation
  • Email Templates
  • Full Blown JWT REST Authentication
  • ... much more

Table of contents

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Generator Restgoose

While running through a leafy mongodb field he picked up mongoose.
Generator-Restgoose scaffolds all API Routes, API Objects ( Bussiness Logic), Schema Models, Test Cases, and even Documentation for you with full CRUD functionality.

To install generator-restgoose from npm, run:

$ npm install -g generator-restgoose

Finally, initiate the generator:

$ yo restgoose

It should output a file structure similiar to:

.bowerrc
.editorconfig
.jshintrc
api/
apiObjects/
config/
... db.js
... lib.js
docs/
public/
models/
routes/
... index.js
test/
views/
bower.json
Gruntfile.js
package.json
Readme.md
  • models - contains Mongoose Schema of an entity ( Data Layer)
  • apiObjects - Contains business logic & model access for each entity ( Business Layer )
  • api - Contains routes of each entity ( Presentation Layer / Controller )
  • test - contains unit test cases for each entity
  • docs - contains Detailed markdown formatted documentation of each Schema generated through the sub-generator.

Don't forget to checkout the config/lib.js file which contains many useful stuff (Json Validator, image to Base64 Converter, etc). Use the Library as var l = require('../config/lib.js); ( which generates with every sub schema).

Try to use l.p('Print something'); to log something. This will log to debug.log file.

Logging Two log files are served : debug.log and access.log.

All responses are in valid jSend spec conformed JSON format.

Prepare for Development Server

Restgoose Apps look for .localrc file in the root of the project. If the file is found, it switches to development mode(more debugginf options) or else falls back to Production Mode. On your development Machine, create a file on the project root .localrc to enable development mode.

Run the app

Development mode

$ grunt 

or

$ grunt server 

Production mode

$ grunt prod 

Sub Generators

Schema

Creates all required Model, Controllers, test cases, routes and documentations for a particular Schema. Run the sub generator for schemas:

$ yo restgoose:schema "article|title:String,excerpt:String,content:String,published:Boolean,created:Date"

output:

You're creating a schema for article
With the fields: title,excerpt,content,published,created
create routes/article.js
create models/article.js
starting request to schematic for test mock data...
create test/test-article.js
create doc/article.md

DeleteSchema

Deletes all files (Model, APi Route, API Object, Doc, Test) for a particular schema. Run the sub generator for deleteschema:

$ yo restgoose:deleteschema "article" --force

N.B. You need to use --force else y=Yeoman will continue asking you to overwrite each file.
output:

You're deleting all files for schema: article

force api/article.js
force apiObjects/article.js
force models/article.js
force docs/article.md
force test/test-article.js

Auth

Enabled Passport + Redis + JWT based Authentication and Authorization for your RESR API server.

$ yo restgoose:auth "auth"

N.B. Run this before creating user model and auth controllers or else, they will be overwritten.
output:

Instantiating Authentication ...


   create api/auth.js
   create apiObjects/auth.js
   create models/user.js
   create middlewares/passport.js
   create docs/auth.md
   create routes/sampleauth.js

You should checkout the docs/auth.md after issuing this command for complete reference.

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

Command List

  • yo restgoose <ProjectName> - initiate a project
  • yo restgoose:schema "<schema>|field:DataType" - Create all routers, models, test and docs for a schema
  • yo restgoose:deleteschema "<Schema>" - Delete all related generated files for a schema
  • grunt - start server with watch enabled
  • npm test - Start Testing generated schemas

Architecture

WIP

ChangeLog

[ 14th Sep 2017 ] v0.2.51

  • Bug Fixes
    • Fixed Small Leftover footprint
    • Fixed EmailTemplate Version Mismatch

[ 14th Sep 2017 ] v0.2.5

  • Optimizations & Upgrades
    • Updated Docs
    • Email Templates
    • NodeMailer Support
    • JSON Server Configuration (server_config.json)
    • Easy Development and production switch (.localrc)
    • Updated Packages
  • Bug Fixes
    • CB for get route
    • Fixed JWT Auth Extractor

[ 26th May 2017 ] v0.2.2

  • Optimizations & Upgrades
    • Updated Docs
  • Bug Fixes
    • Roles for registration
    • Profile name

[ 29th March 2017 ] v0.2.0

  • Migration Since response callbacks are changed, this version is not backwards compatible. However, I am locking down core transport methods ( response calbacks, etc.) so as to make future versions backward compatible.
  • Features
    • Passport + JWT + Redis based out-of-the-box Authentication
    • Authorization Middleware
    • Core Response Lockdown. Future versions will be backwards compatible.
  • Optimizations & Upgrades
    • Updated Docs
    • Changed Response Method to very simple err first callbacks
    • Removed complex response classes
  • Bug Fixes
    • minor memory optimizations

[ 22 Mar 2017 ] v0.1.9

[ 28 Jan 2017 ] v0.1.8

  • Features
    • Universal Search Functionality ( both Strict and Casual Options)
  • Optimizations & Upgrades
    • Updated Docs
  • Bug Fixes
    • fixed test mothod in api

[ 8 Jan 2017 ] v0.1.6

  • Migration
    With as much pain I can endure, this version of generator-restgoose is not backwards-compatible. This comes due to changing the core response object of all API endpoints. I will write up a blog page/wiki very soon for reasons, resolutions and troubleshooting. I personally regret inconveniences caused.
    Despite this, If you need more reasons to keep using this project, read on ...
  • Features
    • Unified JSON response object (jSend)
    • Quick Auto Callback and Response Handlers ( check config/lib.js)
    • Sub-Generator generates document for your schema
    • Wiki & FAQs
    • generated project README
    • New Sub-Generator for deleting a schema, and its files.
  • Optimizations & Upgrades
    • generator-restgoose README (this one)
    • Dedicated github-page and website
    • Changed all broken links
    • Updated All Dependencies
    • Better & Clean Code Generation
    • Better Test Cases

[ 5 Feb 2016 ] v0.1.5

  • Bug Fixed for Test Route in APIs

Bucket List

  • Complete ReadME file for the generated api project
  • Pre-defined generated docs for the generated API endpoints
  • Complete README file for generator-restgoose project (this one)
  • API Versioning System
  • API Dynamic on-demand Doc Generator
  • Conform to REST API Standards
    • out-of-the-box passportJS authentication with JWT * \m/
  • Socket.IO Generator (wohooo)
  • Docker Scripts
  • AutoStart Script using PM2 ( 1 click deploy)
  • Write Reasons, Troubleshooting and migration for v0.1.5 to 0.1.6 in a wiki/blog

Generator Restgoose Core Team

License

MIT
Copyright 2017 Abhishek Deb

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.

MIT License

NPM

NPM