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

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

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

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": "параметр а",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "параметр b",
      "type": "number"
    }
  }
}

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

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

node index.js

5. Протестируйте API

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

Параметры для apiMiddleware

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

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

name: plus
parameters:
  a:
    name: параметр а
    type: number
    length: 3
  b:
    name: параметр b
    type: number

config.js

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

export default {
  name: 'plus',
  parameters: {
    a: {
      name: 'параметр а',
      type: 'number',
      length: 3
    },
    b: {
      name: 'параметр b',
      type: 'number',
      rule: [
        {
          code: 'TOO_BIG',
          message: 'b должен быть меньше 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

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

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

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "параметр а",
      "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"
    }
  }
}

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

контекст

data

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

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

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

exposeApis

Содержит все изложенные API