A Sumor Cloud Tool.
More Documentation
API Middleware is a middleware for Node.JS. It can easily expose function to api, and validate parameters
npm i @sumor/api-middleware --save
Require Node.JS version 18.x or above
As this package is written in ES module, please change the following code in your package.json
file:
{
"type": "module"
}
plus.js
in your project folder api
export default async (context, req, res) => {
const { data } = context
const { a, b } = data
return a + b
}
plus.json
in your project folder api
{
"name": "plus",
"parameters": {
"a": {
"name": "parameter a",
"type": "number",
"length": 3
},
"b": {
"name": "parameter b",
"type": "number"
}
}
}
index.js
fileimport 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
You can use yaml file to define config file, replace plus.json
with plus.yml
name: plus
parameters:
a:
name: parameter a
type: number
length: 3
b:
name: parameter b
type: number
For support js function in config file, you can use config.js
file, replace plus.json
with 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
}
}
]
}
}
}
You can reference below example to apply rules to parameters
{
"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": "must be greater than 0"
}
}
},
"b": {
"name": "parameter b",
"type": "number"
}
}
}
For more usage, please reference Validator
It includes all parameters passed in the request
file upload will be parsed as below object:
name
uploaded file namesize
uploaded file size(bytes)mime
uploaded file mime type(e.g. image/png)encoding
uploaded file encoding(e.g. 7bit)path
uploaded file pathIt includes all exposed apis