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.

Versión de NPM Descargas de NPM CI de GitHub Prueba de GitHub Cobertura de GitHub Auditoría de GitHub

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

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
}
  1. [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"
    }
  }
}
  1. 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')
})
  1. Ejecuta index.js
node index.js
  1. Prueba la API
curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'

o utiliza 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

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

El tipo solo soporta 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 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 hacer referencia al 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": "必须大于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 solicitud

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

exposeApis

Incluye todas las APIs expuestas