restalize

    1.1.11 • Public • Published

    RESTalize

    kennasoft codecov

    Restalize is a robust Code generator that receives a relational database connection as input and creates a node.js-based REST api project in a specified folder.

    Installation

    Although you can install the package globally and execute it as a binary, it is recommended that you run it using npx

    Global installation

    Using yarn:

    yarn global add restalize

    Using npm:

    npm install -g restalize

    Running Restalize

    To generate a new api, you need to invoke the restalize command, passing one required argument (The target project directory path) with other optional flags. You can do this via npx or from a global install

    Using npx

    npx restalize my-rest-api

    Using global install

    restalize my-rest-api

    When invoked as above with no flags other than the directory name, the underlying entity generation module, typeorm-model-generator will prompt you for parameters like database-name, user, password, host, port etc.

    For a full description of usage, type npx restalize --help, to see the below guide in your terminal:

    Usage: restalize <project-folder> [options]
     
    Options:
      -V, --version                            output the version number
      -l, --lang <language>                    The language you want your generated api in. Options are: [typescript, es2015, esnext] (default: "typescript")
      -h, --host <database-host>               database host from which you want to generate the api. (default: "localhost")
      -p, port <database-port>                 database port to connect to. (default: "3306")
      -d, --database <database-name>           database name to generate entities from.
      -u, --username <database-user>           the database user you want to connect with
      -x, --password <database-user-password>  the password for database user you want to connect with
      --skipTables <list-of-tables-to-skip>    comma-separated list of table names to be excluded
      -e, --engine <database-engine>           database engine to use.
            Options are
              * mysql
              * mssql
              * postgres
              * mariadb
              * oracle
              * sqlite
           (default: "mysql")
      --help                                   display help for command

    The generated API reference can be found here

    Install

    npm i restalize

    DownloadsWeekly Downloads

    1

    Version

    1.1.11

    License

    MIT

    Unpacked Size

    2.39 MB

    Total Files

    61

    Last publish

    Collaborators

    • kennasoft