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 una API y validar parámetros

Instalación

npm i @sumor/api-middleware --save

Requisitos previos

Versión de Node.JS

Se requiere la versión de Node.JS 18.x o superior

Requiere módulo ES de Node.JS

Dado que 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. 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()
apiMiddleware(app, process.cwd() + '/api')

app.listen(3000, () => {
  console.log('El servidor está corriendo en http://localhost:3000')
})

4. Ejecuta index.js

node index.js

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

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 el archivo de configuración, puedes usar el 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 debe ser menor que 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

Regla de Parámetros

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

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

Para más usos, por favor consulta Validador

contexto

data

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

La carga de archivos se analizará como un objeto de la siguiente manera:

• 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