api-middleware

Инструмент Sumor Cloud.
Дополнительная документация
API Middleware – это промежуточное ПО для Node.JS.
Он легко может выставлять функцию в API и проверять параметры

Установка

npm i @sumor/api-middleware --save

Предварительные требования

Версия Node.JS

Требуется Node.JS версии 16.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": "parameter a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

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

Контекст

data

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

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

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

exposeApis

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