lazy-express-api v1.0.2

Lazy API

Fast generate CRUD api. Use for express, sequelize

Dependencies

• express
• sequelize

Installation

npm install --save-dev lazy-express-api

And then you should be able to run the CLI with

npx lazy-express-api --help

Usage

lazy-api <command>

Commands:
  lazy-api all                        Generate CRUD
  lazy-api helpers                    Generate Helpers Files

Options:
  --version  Show version number                                                  [boolean]
  --help     Show help                                                            [boolean]

Please specify a command

Config file

Create lazy-api/config.json

{
  "modelPath": "src/models",                  // Default `models`
  "migrationPath": "src/database/migrations", // Default `migrations`
  "controllersPath": "src/controllers",       // default `controllers`
  "servicesPath": "src/services",             // default `services`
  "routesPath": "src/routes",                 // default `routes`
  "helpersPath": "src/helpers"                // default `helpers`
}

JSON file

Example lazy-api/json-files/post.json

{
  "controllersPath": "src/controllers", // overwrite `config.json`
  "servicesPath": "src/services",       // overwrite `config.json`
  "routesPath": "src/routes",           // overwrite `config.json`
  "name": "post",
  "attributes": [
    {
      "name": "title",
      "type": "string",
      "allowNull": false
    },
    {
      "name": "description",
      "type": "string",
      "allowNull": false
    },
    {
      "name": "type",
      "type": "string",
      "modelType": "enum",
      "values": ["public", "private"],
      "defaultValue": "public"
    }
  ]
}

Example run Generate CRUD:

npx lazy-express-api all --path lazy-api/json-files/post.json

Helper files

To run CRUD require some helper files (api-error-helper.js, utils-helper.js). To generate:

npx lazy-express-api helpers