Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@blueprod/ws-mvc-loader

0.1.1 • Public • Published

ws-mvc-loader

An utility module that supports to load the API definition is various structure and formats:

Your api structure should be (you could customize):

* api
   |--- config              -> containing the definition for the API routes
           |--- routes.js
           |--- routes.json 
   |--- controllers         -> containing the api handlers for defined routes
   |--- services            -> containing the business services for handling of the business logic
  

Notes:

  • Route files should be provided as glob pattern, for example, user-routes.js

Example of a Route file

{
  "routes": [
    {
      "method": "GET",
      "path": "/products",
      "handler": "product.list",
      "config": {
        "auth": false
      }
    },
    {
      "method": "GET",
      "path": "/products/count",
      "handler": "product.count",
      "config": {
        "auth": false
      }
    }
  ]
}

Install

npm i @blueprod/ws-mvc-loader

DownloadsWeekly Downloads

2

Version

0.1.1

License

MIT

Unpacked Size

39.2 kB

Total Files

18

Last publish

Collaborators

  • avatar
  • avatar