api-middleware

Una herramienta de Sumor Cloud.
Más Documentación

API Middleware es un middleware para Node.JS. Puede exponer fácilmente funciones a la API y validar parámetros.

Instalación

npm i @sumor/api-middleware --save

Prerrequisitos

Versión de Node.JS

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

Requiere módulo ES de Node.JS

Dado que 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. Agrega 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
}

2. [Opcional] Agrega un archivo de configuración 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. Agrega el siguiente código en tu archivo 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('El servidor se está ejecutando en http://localhost:3000')
})

4. Ejecuta index.js

node index.js

5. Prueba la API

curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'

o utiliza un navegador para abrir http://localhost:3000/plus?a=1&b=2

Opciones para 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 => {
    // haz algo antes de la API
  },
  finalize: async (context, result) => {
    // haz algo después de la API
  },
  exception: async (context, error) => {
    // maneja el error
  }
})
app.listen(3000, () => {
  console.log('El servidor se está ejecutando en http://localhost:3000')
})

Más Tipos de Archivos de Configuración

yaml

Puedes usar un archivo yaml para definir el archivo de configuración, reemplaza plus.json con plus.yml

El tipo solo admite number, string, boolean, array, object

name: plus
parameters:
  a:
    name: parámetro a
    type: number
    length: 3
  b:
    name: parámetro b
    type: number

config.js

Para soportar funciones JS en los archivos de configuración, puedes usar un archivo config.js, reemplaza plus.json con plus.config.js

export default {
  name: 'plus',
  parameters: {
    a: {
      name: 'parámetro a',
      type: 'number',
      length: 3
    },
    b: {
      name: 'parámetro b',
      type: 'number',
      rule: [
        {
          code: 'TOO_BIG',
          message: 'b debería ser menor que 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

Reglas de Parámetros

Puedes consultar el siguiente ejemplo para aplicar reglas a los parámetros

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parámetro a",
      "type": "number",
      "length": 3,
      "rule": [
        {
          "code": "MAYOR_QUE_0",
          "expression": "^[1-9][0-9]*$",
          "message": "debe ser mayor que 0"
        }
      ],
      "i18n": {
        "zh": {
          "MAYOR_QUE_0": "debe ser mayor que 0"
        }
      }
    },
    "b": {
      "name": "parámetro b",
      "type": "number"
    }
  }
}

Para más usos, por favor consulta Validador

context

data

Incluye todos los parámetros pasados en la petición

La carga de archivos se analizará como el siguiente objeto:

• name nombre del archivo cargado
• size tamaño del archivo cargado (bytes)
• mime tipo MIME del archivo cargado (por ejemplo, image/png)
• encoding codificación del archivo cargado (por ejemplo, 7bit)
• path ruta del archivo cargado

exposeApis

Incluye todas las API expuestas