api-middleware

Una Herramienta 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

Requisitos previos

Versión de Node.JS

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

require Node.JS ES module

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

{
  "type": "module"
}

Uso

Uso Básico

1. Agregue 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] Agregue un archivo 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. Agregue el siguiente código en su 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á en ejecución en http://localhost:3000')
})

4. Ejecute index.js

node index.js

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": "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, consulte Validador

context

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 (por ejemplo, image/png)
• encoding codificación del archivo cargado (por ejemplo, 7 bits)
• path ruta del archivo cargado

exposeApis

Incluye todas las api expuestas