JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q83621F
  • License MIT

Scaffold an Express.js boilerplate project. You can generate express.js boilerplate code with a single command.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (express-api-creator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Express API Creator

    NPM version NPM downloads License

    Express API Creator is a powerful and flexible Node.js CLI and library designed to rapidly bootstrap and manage Express.js RESTful APIs. It simplifies the process of creating well-structured, feature-rich API backends with minimal configuration, allowing developers to focus on business logic rather than boilerplate code. Supports both JavaScript and TypeScript.

    Features

    • Create Project:

      • CLI: Quickly generate a new Express.js project boilerplate.
        • npx express-api-creator create
      • Languages support
        • JavaScript
        • TypeScript

    • Create MCR (Model/Controller/Route):

      • CLI: Generate Model, Controller and Route files for a new project with a single command.
        • npx express-api-creator mcr
        • Note: Be sure you are in project folder.

    • Default Routes:

      • Authentication:

        • POST /auth/login
        • POST /auth/register
        • POST /auth/reset-password
        • POST /auth/forgot-password

      • User Management:

        • GET /user/list
        • GET /user/my-profile
        • POST /user/upload-image
        • PUT /user/update-password

    • Automatic Route Generation (Library): Define your API endpoints and their logic in a simple configuration file or directly in your code, and express-api-creator can handle the route setup when used as a library.

    • Middleware Integration: Easily integrate custom or third-party Express middleware. This includes functionalities like authentication (e.g., protecting routes with auth middleware), logging, validation, and more, applicable globally or on a per-route basis.

    • Controller Support: Structures your API logic into controllers for better organization and maintainability. Generated controllers often include stubs for common CRUD operations and other resource-specific actions, such as:

      • create(): Add a new resource.
      • update(): Modify an existing resource.
      • list(): Retrieve a collection of resources.
      • details(): Get a single resource by its identifier.
      • softDelete(): Remove a resource (can be a soft delete).

    • Response: Well structured response for succuss & error.

    • File Upload: you can upload single image with express-file-upload.

    • Service Layer Abstraction: Encourages the use of a service layer to separate business logic from request handling.

    • Error Handling: Includes a default error handling mechanism that can be customized.

    • Asynchronous Support: Built to work seamlessly with asynchronous operations and Promises.

    • Highly Extensible: Designed to be flexible and allow developers to extend its core functionalities.

    • Rapid Prototyping: Get your API up and running in minutes, ideal for quick prototyping and MVPs.

    • Structured Project Layout: Promotes a clean and organized project structure.

    How to use

    • npx express-api-creator create
    • cd <project-name>
    • npx express-api-creator mcr

    How to run

    • npm run dev