api-middleware

Uma Ferramenta Sumor Cloud.
Documentação Adicional

API Middleware é um middleware para Node.JS. Ele pode facilmente expor uma função para a API e validar parâmetros

Instalação

npm i @sumor/api-middleware --save

Pré-requisitos

Versão do Node.JS

Requer Node.JS versão 18.x ou superior

Requer módulo ES do Node.JS

Como este pacote é escrito em módulo ES, por favor altere o seguinte código em seu arquivo package.json:

{
  "type": "module"
}

Uso

Uso Básico

1. Adicione um arquivo chamado plus.js na pasta do projeto api

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

2. [Opcional] Adicione um arquivo chamado plus.json na pasta do projeto api

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parametro a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parametro b",
      "type": "number"
    }
  }
}

3. Adicione o seguinte código no seu arquivo 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('Servidor está rodando em http://localhost:3000')
})

4. execute index.js

node index.js

Regra de Parâmetros

Você pode consultar o exemplo abaixo para aplicar regras aos parâmetros

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

Para mais exemplos, por favor consulte Validador

contexto

data

Inclui todos os parâmetros passados na requisição

O upload de arquivo será analisado como o objeto abaixo:

• name nome do arquivo enviado
• size tamanho do arquivo enviado (bytes)
• mime tipo de mime do arquivo enviado (por exemplo, image/png)
• encoding codificação do arquivo enviado (por exemplo, 7bit)
• path caminho do arquivo enviado

exposeApis

Inclui todas as APIs expostas