API

Getting started with the api.

Install

npm i -g sugar-generate

Prereqs

• have mongodb installed and running!
• have nodejs installed

if you're running mongodb locally and using the docker container, make sure to start mongo using

sudo mongod --bind_ip_all

otherwise you wont be able to connect to mongo from docker.

Getting Started

1. Create your schema. It could be as simple as:

{
  "schema": {
    "name": {
      "type": "String",
      "default": ""
    },
    "isDead": {
      "type": "Boolean",
      "default": false
    },
    "age": {
      "type": "Number",
      "default": false
    }
  },
  "statics": {}
}

You can also provide multiple schemas like the following

[
  {
    "name": "user",
    "schema": {
      "name": {
        "type": "String",
        "default": ""
      },
      "email": {
        "type": "String",
        "trim": true,
        "required": true,
        "unique": true,
        "immutable": true
      },
      "intro": {
        "type": "Boolean",
        "default": false
      },
      "sub": {
        "one": {
          "type": "String",
          "trim": true,
          "required": true
        },
        "two": {
          "type": "String",
          "required": true
        },
        "three": {
          "type": "Number"
        }
      },
      "role": {
        "type": "String",
        "enum": ["user", "maker"],
        "default": "user"
      }
    },
    "statics": {
      "statuses": ["created", "under_review", "listed", "deleted"],
      "status": {
        "active": "active",
        "inactive": "inactive",
        "deleted": "deleted"
      }
    }
  },
  {
    "name": "team",
    "schema": {
      "name": {
        "type": "String",
        "default": ""
      },
      "users": {
        "type": "ObjectId",
        "ref": "Users"
      }
    }
  }
]

save this to monkey.json

2. generate your api

sugar-generate \
--schema ./monkey.json \
--destination ./my-monkeys

or the short version

sugar-generate \
-s ./monkey.json \
-d ./my-monkeys

Note this is slightly different than previous versions. The schemas require a name now.

3. Run or build the docker container and visit http://localhost:3000

cd /my-monkeys
npm i
npm start
# Or build the docker container!
docker build -t myMonkeys:0.1.0 .

Features 🙉

• Generates simple Nodejs code
• Graphql and Rest out of the box
• Uses Mongodb with Mongoose ORM
• Easy to build / deploy
• Dockerfile included
• supports multiple schemas
• Generates CRUD APIs
  • create
  • get (many, with pagination; supports search, sort, filter, pagination out of the box)
  • getOne
  • update
  • delete
• Generates GraphQL apis for both query and mutation

What it's good at 🙊

• Generating an initial API
• Microservice oriented
• Ready to deploy (build with docker => deploy)

What it's not good at (yet) 🙈

• idempotent changes (i.e. it doesn't know if you wrote code in there or changed things around)
• working with modified code
• populating table joins
• custom actions inside controller functions

TODO

API

• basic generator rest tests
• graphql tests
• other databases?
• your ideas?
• middleware for auth, token validation, etc.

Graphql support

graphql is supported and gets created by default so you can choose between rest and graphql

Graphql is on http://localhost:3000/graphql

Generated project structure

.
├── configs                 # Config File
├── connection              # DB Connections (mongo, redis)
├── controller              # Controllers
│   ├── <model name>        # Functions (one file, one function) create, delete, update, get, getOne
├── models                  # DB Models
├── router                  # Endpoint Routes
├── tests                   # Single Test File

Generated tests

** WARNING ** running the tests will pull the config file from configs/config.json and clear the DB

npm run test