Uma ferramenta Sumor Cloud.
Documentação Adicional
API Middleware é um middleware para Node.JS. Ele pode expor facilmente funções para a API e validar parâmetros
npm i @sumor/api-middleware --save
Requer a versão 18.x ou superior 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"
}
plus.js
na pasta do projeto api
export default async (context, req, res) => {
const { data } = context
const { a, b } = data
return a + b
}
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"
}
}
}
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('O servidor está rodando em http://localhost:3000')
})
node index.js
curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'
ou utilize um navegador para abrir http://localhost:3000/plus?a=1&b=2
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 após a API
},
exception: async (context, error) => {
// lidar com erro
}
})
app.listen(3000, () => {
console.log('O servidor está rodando em http://localhost:3000')
})
Você pode usar um arquivo yaml para definir o arquivo de configuração, substitua plus.json
por plus.yml
tipo suporta apenas number
, string
, boolean
, array
, object
name: plus
parameters:
a:
name: parâmetro a
type: number
length: 3
b:
name: parâmetro b
type: number
Para dar suporte a 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
}
}
]
}
}
}
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": "precisa ser maior que 0"
}
}
},
"b": {
"name": "parâmetro b",
"type": "number"
}
}
}
Para mais uso, consulte Validador
Inclui todos os parâmetros passados na requisição
o upload do arquivo será analisado como abaixo:
name
nome do arquivo enviadosize
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 enviadoInclui todas as APIs expostas