api-middleware

Uma Ferramenta Sumor Cloud.
Mais Documentação

O API Middleware é um middleware para o Node.JS.
Ele pode facilmente expor funções 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 na versão 18.x ou superior.

Requer módulo ES do Node.JS

Como este pacote é escrito em módulo ES, por favor faça a seguinte alteração no 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 de configuração chamado plus.json na pasta do projeto api

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parâmetro a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parâmetro b",
      "type": "number"
    }
  }
}

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

4. Execute o index.js

node index.js

5. Teste a API

curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'

ou utilizando o navegador para abrir http://localhost:3000/plus?a=1&b=2

Opções 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 => {
    // faça algo antes da API
  },
  finalize: async (context, result) => {
    // faça algo depois da API
  },
  exception: async (context, error) => {
    // gerencie o erro
  }
})
app.listen(3000, () => {
  console.log('Servidor rodando em http://localhost:3000')
})

Mais Tipos de Arquivos de Configuração

yaml

Você pode usar um arquivo yaml para definir o arquivo de configuração, substitua plus.json por plus.yml

name: plus
parameters:
  a:
    name: parâmetro a
    type: number
    length: 3
  b:
    name: parâmetro b
    type: number

config.js

Para suportar funções js no arquivo de configuração, você pode usar o arquivo config.js, substitua plus.json por 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 deve ser menor que 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

Regra de Parâmetros

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

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

Para mais usos, consulte Validador

contexto

data

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

O envio de arquivos será analisado como o objeto abaixo:

• name nome do arquivo enviado
• size tamanho do arquivo enviado (bytes)
• mime tipo 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