api-middleware

Uma Ferramenta Sumor Cloud.
Mais Documentação API Middleware é um middleware para Node.JS. Pode facilmente expor função para API, e validar parâmetros

Instalação

npm i @sumor/api-middleware --save

Pré-requisitos

Versão Node.JS

Requer Node.JS versão 16.x ou acima

Requer módulo ES Node.JS

Como este pacote é escrito em módulo ES, por favor mude o seguinte código 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
}

[Opcional] 2. Adicione um arquivo 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 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

contexto

data

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

o upload de arquivo será analisado como 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