api-middleware

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

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

Использование

Основное использование

1. Добавьте файл с именем plus.js в папку проекта api

export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

2. [Опционально] Добавьте файл конфигурации с именем plus.json в папку проекта api

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "параметр a",
      "type": "число",
      "длина": 3
    },
    "b": {
      "name": "параметр b",
      "type": "число"
    }
  }
}

3. Добавьте следующий код в ваш файл 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')
})

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

node index.js

Дополнительные типы файлов конфигурации

yaml

Вы можете использовать файл yaml для определения файла конфигурации, замените plus.json на plus.yml

name: plus
parameters:
  a:
    name: параметр a
    type: число
    length: 3
  b:
    name: параметр b
    type: число

config.js

Для поддержки 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": "число",
      "длина": 3,
      "rule": [
        {
          "code": "GREATER_THAN_0",
          "expression": "^[1-9][0-9]*$",
          "message": "должн быть больше 0"
        }
      ],
      "i18n": {
        "zh": {
          "GREATER_THAN_0": "должен быть больше 0"
        }
      }
    },
    "b": {
      "name": "параметр b",
      "type": "число"
    }
  }
}

Для дополнительных примеров обратитесь к Validator

Контекст

data

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

Загружаемый файл будет обработан как следующий объект:

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

exposeApis

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