@sumor/api-middleware

api-middleware

A Sumor Cloud Tool.
More Documentation API Middleware is a middleware for Node.JS. It can easily expose function to api, and validate parameters

Installation

npm i @sumor/api-middleware --save

Prerequisites

Node.JS version

Require Node.JS version 16.x or above

require Node.JS ES module

As this package is written in ES module, please change the following code in your package.json file:

{
  "type": "module"
}

Usage

Basic Usage

1. Add a file named plus.js in your project folder api

export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

[Optional] 2. Add a file named plus.json in your project folder api

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parameter a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

1. Add the following code in your index.js file

import express from 'express'
import apiMiddleware from '@sumor/api-middleware'

const app = express()
apiMiddleware(app, process.cwd() + '/api')

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000')
})

1. run index.js

   node index.js