api-middleware

一个Sumor Cloud工具。
更多文档

API中间件是用于Node.JS的中间件。 它可以轻松将函数暴露给API，并验证参数

安装

npm i @sumor/api-middleware --save

先决条件

Node.JS版本

需要 Node.JS 版本18.x或更高

要求Node.JS ES模块

由于此包是用ES模块编写的，请在您的package.json文件中进行以下更改:

{
  "type": "module"
}

用法

基本用法

1. 在您的项目文件夹api中添加名为plus.js的文件

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

2. [可选] 在您的项目文件夹api中添加一个名为plus.json的配置文件

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

3. 在您的index.js文件中添加以下代码

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

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

app.listen(3000, () => {
  console.log('服务器正在运行，地址为 http://localhost:3000')
})

4. 运行 index.js

node index.js

更多配置文件类型

yaml

您可以使用yaml文件来定义配置文件，将plus.json替换为plus.yml

name: plus
parameters:
  a:
    name: parameter a
    type: number
    length: 3
  b:
    name: parameter b
    type: number

config.js

为了支持配置文件中的js函数，您可以使用config.js文件，将plus.json替换为plus.config.js

export default {
  name: 'plus',
  parameters: {
    a: {
      name: 'parameter a',
      type: 'number',
      length: 3
    },
    b: {
      name: 'parameter b',
      type: 'number',
      rule: [
        {
          code: 'TOO_BIG',
          message: 'b应小于100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

参数规则

您可以参考以下示例为参数应用规则

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parameter a",
      "type": "number",
      "length": 3,
      "rule": [
        {
          "code": "GREATER_THAN_0",
          "expression": "^[1-9][0-9]*$",
          "message": "必须大于0"
        }
      ],
      "i18n": {
        "zh": {
          "GREATER_THAN_0": "必须大于0"
        }
      }
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

有关更多用法，请参考验证器

上下文

data

它包含请求中传递的所有参数

文件上传将被解析为以下对象:

• name 上传的文件名
• size 上传的文件大小（字节）
• mime 上传的文件MIME类型（例如, image/png）
• encoding 上传的文件编码（例如, 7bit）
• path 上传的文件路径

exposeApis

它包含所有暴露的APIs