api-middleware

Una Herramienta Sumor Cloud.
Más Documentación

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

Instalación

npm i @sumor/api-middleware --save

Requisitos previos

Versión de Node.JS

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

Requiere módulo ES de Node.JS

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

{
  "type": "module"
}

Uso

Uso Básico

1. Agregar un archivo llamado plus.js en la carpeta de su proyecto api

export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

2. [Opcional] Agregar un archivo de configuración llamado plus.json en la carpeta de su 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 su 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. Ejecutar index.js

node index.js

5. Probar la API

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

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

Más Tipos de Archivos de Configuración

yaml

Puede utilizar archivos yaml para definir archivos de configuración, reemplace plus.json con plus.yml

El tipo solo es compatible con 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 admitir funciones js en archivos de configuración, puede utilizar el archivo config.js, reemplace 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 debe ser menor que 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

Regla de Parámetros

Puede hacer referencia al ejemplo a continuación 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": {
        "es": {
          "MAYOR_QUE_0": "debe ser mayor que 0"
        }
      }
    },
    "b": {
      "name": "parámetro b",
      "type": "number"
    }
  }
}

Para más uso, por favor consulte Validator

contexto

data

Incluye todos los parámetros pasados en la solicitud

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 (p. ej., image/png)
• encoding codificación del archivo cargado (p. ej., 7bit)
• path ruta del archivo cargado

exposeApis

Incluye todas las APIs expuestas