api-middleware

一个 Sumor Cloud 工具。 更多文档

API Middleware 是用于 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": "参数a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "参数b",
      "type": "number"
    }
  }
}

3. 在 index.js 文件中添加如下代码。

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

const app = express()

await apiMiddleware(app, process.cwd() + '/api')

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

4. 运行 index.js

node index.js

5. 测试 API

curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'

或者在浏览器中打开 http://localhost:3000/plus?a=1&b=2

apiMiddleware 的选项

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

const app = express()

await apiMiddleware(app, process.cwd() + '/api', {
  prefix: '/api',
  prepare: async context => {
    // 在调用 API 之前执行某些操作
  },
  finalize: async (context, result) => {
    // 在调用 API 后执行某些操作
  },
  exception: async (context, error) => {
    // 处理错误
  }
})

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

更多配置文件类型

yaml

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

type 仅支持 number、string、boolean、array、object

name: plus
parameters:
  a:
    name: 参数a
    type: number
    length: 3
  b:
    name: 参数b
    type: number

config.js

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

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

参数规则

您可以参考下面的示例，将规则应用于参数

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "参数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": "参数b",
      "type": "number"
    }
  }
}

要了解更多用法，请参考 验证器

上下文

data

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

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

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

exposeApis

它包含所有暴露的 API。