A Sumor Cloud Tool.
Больше документации
API Middleware - это промежуточное ПО для Node.JS. Он легко предоставляет функцию для API и проверяет параметры
npm i @sumor/api-middleware --save
Требуется версия Node.JS 18.x и выше
Поскольку этот пакет написан на модуле ES,
пожалуйста, измените следующий код в вашем файле package.json
:
{
"type": "module"
}
plus.js
в папку проекта api
export default async (context, req, res) => {
const { data } = context
const { a, b } = data
return a + b
}
plus.json
в папку проекта api
{
"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('Сервер работает по адресу 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 должен быть меньше 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"
}
}
}
Для получения дополнительной информации обратитесь к Валидатору
Он включает все параметры, переданные в запросе
файл загрузки будет разобран следующим образом:
name
имя загруженного файлаsize
размер загруженного файла (байт)mime
тип медиа загруженного файла (например, image/png)encoding
кодировка загруженного файла (например, 7bit)path
путь к загруженному файлуОн включает все открытые API