grapi v0.1.0

Api Generator

CLI Tool generator REST API using NodeJS, Express and Mongoose.

How to build project:

Installation

npm install -g grapi

This will install grapit globally on your system.

Basic Usages

Create config.json on project folder.

Example config.json:

{
    "appName": "Demo",
    "mongoURL": "mongodb://Test123:Test123@ds145299.mlab.com:45299/dbtest123",
    "port": 2308,
    "authenticate": true,
    "posts": {
        "id": "Number",
        "title": "String",
        "author": "String"
    },
    "comments": {
        "body": "String",
        "postId": "Number"
    }
}

appName, mongoURL, port and authenticate is default and you can add or replace model... :)))

Create a New Rest API

On current folder, open terminal and run

grapi new

Basic Directory Structure

- api
|-- controllers
|-- node_modules
|-- models
|-- routes
- .gitignore
- package.json
- server.js

Running API:

cd Demo #appName
npm start

Start your API at http://localhost:2308/ (Your PORT config) and simple CRUD with url is http://localhost:2308/v1 (v1 is versioning, can config after running app.)

Documents API at http://localhost:2308/api-docs

To Get help about this CLI

grapi --help

Happy Coding..!!