api-middleware

Una Herramienta de Sumor Cloud.
Más Documentación
API Middleware es un middleware para Node.JS.
Puede exponer fácilmente una función a la API y validar parámetros

CI
Test
Coverage
Audit

Instalación

npm i @sumor/api-middleware --save

Requisitos previos

Versión de Node.JS

Requiere Node.JS versión 16.x o superior

Requerir módulo ES de Node.JS

Como este paquete está escrito en módulo ES, por favor cambia el siguiente código en tu archivo package.json:

{
  "type": "module"
}

Uso

Uso Básico

1. Agregar un archivo llamado plus.js en la carpeta de tu proyecto api
export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}
[Opcional] 2. Agregar un archivo llamado plus.json en la carpeta de tu proyecto api
{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parámetro a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parámetro b",
      "type": "number"
    }
  }
}
3. Agregar el siguiente código en tu archivo 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('El servidor se está ejecutando en http://localhost:3000')
})
4. Ejecutar index.js
node index.js