api-middleware

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

CI Test Coverage Audit

Установка

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": "параметр а",
      "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()
apiMiddleware(app, process.cwd() + '/api')

app.listen(3000, () => {
  console.log('Сервер работает на http://localhost:3000')
})
4. Запустите index.js
node index.js