api-middleware

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

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

Instalación

npm i @sumor/api-middleware --save

Requisitos previos

Versión de Node.JS

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

Requiere módulo de ES de Node.JS

Dado que este paquete está escrito en módulo de 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 del 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 del 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 use su 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 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

Puede usar un archivo yaml para definir el archivo de configuración, reemplace 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, puede usar 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 should be less than 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

Regla de Parámetro

Puede 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": "debe ser mayor que 0"
        }
      }
    },
    "b": {
      "name": "parámetro b",
      "type": "number"
    }
  }
}

Para más uso, consulte Validador

contexto

datos

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, 7bit)
• path ruta del archivo cargado

exposeApis

Incluye todas las API expuestas