一个 Sumor Cloud 工具。
更多文档
API Middleware 是用于 Node.JS 的中间件。
它可以轻松地向 API 暴露函数,并验证参数。
npm i @sumor/api-middleware --save
需要 Node.JS 版本 18.x 或更高
由于本包使用 ES 模块编写,请在您的 package.json
文件中更改以下代码:
{
"type": "module"
}
api
中添加名为 plus.js
的文件export default async (context, req, res) => {
const { data } = context
const { a, b } = data
return a + b
}
api
中添加名为 plus.json
的配置文件{
"name": "plus",
"parameters": {
"a": {
"name": "parameter a",
"type": "number",
"length": 3
},
"b": {
"name": "parameter b",
"type": "number"
}
}
}
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('Server is running on http://localhost:3000')
})
node index.js
您可以使用 yaml 文件定义配置文件,将 plus.json
替换为 plus.yml
name: plus
parameters:
a:
name: parameter a
type: number
length: 3
b:
name: parameter b
type: number
为支持配置文件中的 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 should be less than 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": "must be greater than 0"
}
],
"i18n": {
"zh": {
"GREATER_THAN_0": "必须大于0"
}
}
},
"b": {
"name": "parameter b",
"type": "number"
}
}
}
欲了解更多用法,请参考 验证器
它包含请求中传递的所有参数
文件上传将解析为以下对象:
name
上传的文件名size
上传的文件大小(字节)mime
上传的文件 MIME 类型(例如 image/png)encoding
上传的文件编码(例如 7bit)path
上传的文件路径它包含所有暴露的 API