API中间件是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": "参数a",
"type": "数字",
"length": 3
},
"b": {
"name": "参数b",
"type": "数字"
}
}
}
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')
})
node index.js
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
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文件定义配置文件,将 plus.json
替换为 plus.yml
name: plus
parameters:
a:
name: 参数a
type: 数字
length: 3
b:
name: 参数b
type: 数字
为了支持配置文件中的js函数,您可以使用 config.js
文件,将 plus.json
替换为 plus.config.js
export default {
name: 'plus',
parameters: {
a: {
name: '参数a',
type: '数字',
length: 3
},
b: {
name: '参数b',
type: '数字',
rule: [
{
code: 'TOO_BIG',
message: 'b 应该小于100',
function: function (value) {
return value < 100
}
}
]
}
}
}
您可以参考以下示例,将规则应用于参数
{
"name": "plus",
"parameters": {
"a": {
"name": "参数a",
"type": "数字",
"length": 3,
"rule": [
{
"code": "GREATER_THAN_0",
"expression": "^[1-9][0-9]*$",
"message": "必须大于0"
}
],
"i18n": {
"zh": {
"GREATER_THAN_0": "必须大于0"
}
}
},
"b": {
"name": "参数b",
"type": "数字"
}
}
}
更多使用方式,请参考 验证器
其中包含请求中传递的所有参数
文件上传将解析为以下对象:
name
上传的文件名size
上传的文件大小(字节)mime
上传的文件MIME类型(例如 image/png)encoding
上传的文件编码(例如 7bit)path
上传的文件路径其中包含所有暴露的API