api-middleware

Инструмент Sumor Cloud.
Дополнительная документация

API Middleware представляет собой промежуточное ПО для Node.JS. Он позволяет легко предоставлять функцию для API и проверять параметры.

Установка

npm i @sumor/api-middleware --save

Предпосылки

Версия Node.JS

Требуется версия Node.JS 18.x или выше.

Требуется модуль ES для Node.JS

Поскольку этот пакет написан на модуле 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": "параметр a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "параметр 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')
})

Запустите index.js

node index.js

Правило параметра

Вы можете использовать приведенный ниже пример для применения правил к параметрам

{
  "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"
    }
  }
}

Для получения дополнительной информации об использовании обратитесь к Валидатору

context

data

Включает все параметры, переданные в запросе

Файл загрузки будет разобран как объект ниже:

name имя загруженного файла
size размер загруженного файла (в байтах)
mime медиа-тип загруженного файла (например, image/png)
encoding кодировка загруженного файла (например, 7bit)
path путь загруженного файла

exposeApis

Включает все предоставленные API