Ein Sumor Cloud Tool.
Weitere Dokumentation
API Middleware ist ein Zwischenschicht-Tool für Node.JS.
Es kann Funktionen leicht in APIs freigeben und Parameter validieren.
npm i @sumor/api-middleware --save
Erfordert Node.JS Version 18.x oder höher.
Da dieses Paket in ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json
-Datei:
{
"type": "module"
}
plus.js
in Ihrem Projektordner api
hinzuexport default async (context, req, res) => {
const { data } = context
const { a, b } = data
return a + b
}
plus.json
in Ihrem Projektordner api
hinzu{
"name": "plus",
"parameters": {
"a": {
"name": "Parameter a",
"type": "number",
"length": 3
},
"b": {
"name": "Parameter b",
"type": "number"
}
}
}
index.js
-Datei einimport express from 'express'
import apiMiddleware from '@sumor/api-middleware'
const app = express()
await apiMiddleware(app, process.cwd() + '/api')
app.listen(3000, () => {
console.log('Server läuft unter http://localhost:3000')
})
index.js
ausnode index.js
curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'
oder öffnen Sie im Browser http://localhost:3000/plus?a=1&b=2
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 => {
// etwas vor der API machen
},
finalize: async (context, result) => {
// etwas nach der API machen
},
exception: async (context, error) => {
// Fehler behandeln
}
})
app.listen(3000, () => {
console.log('Server läuft unter http://localhost:3000')
})
Sie können eine YAML-Datei verwenden, um die Konfigurationsdatei zu definieren. Ersetzen Sie plus.json
durch plus.yml
name: plus
parameters:
a:
name: Parameter a
type: number
length: 3
b:
name: Parameter b
type: number
Um JS-Funktionen in der Konfigurationsdatei zu unterstützen, können Sie die Datei config.js
verwenden. Ersetzen Sie plus.json
durch plus.config.js
export default {
name: 'plus',
parameters: {
a: {
name: 'Parameter a',
type: 'number',
length: 3
},
b: {
name: 'Parameter b',
type: 'number',
rule: [
{
code: 'TOO_BIG',
message: 'b sollte kleiner als 100 sein',
function: function (value) {
return value < 100
}
}
]
}
}
}
Sie können das folgende Beispiel verwenden, um Regeln auf Parameter anzuwenden
{
"name": "plus",
"parameters": {
"a": {
"name": "Parameter a",
"type": "number",
"length": 3,
"rule": [
{
"code": "GREATER_THAN_0",
"expression": "^[1-9][0-9]*$",
"message": "muss größer als 0 sein"
}
],
"i18n": {
"zh": {
"GREATER_THAN_0": "muss größer als 0 sein"
}
}
},
"b": {
"name": "Parameter b",
"type": "number"
}
}
}
Weitere Beispiele finden Sie unter Validator
Es enthält alle Parameter, die in der Anforderung übergeben wurden
Datei-Uploads werden als folgendes Objekt analysiert:
Name
: hochgeladener DateinameGröße
: hochgeladene Dateigröße (Bytes)MIME
: hochgeladener Datei-MIME-Typ (z.B. image/png)Codierung
: hochgeladene Datei-Codierung (z.B. 7bit)Pfad
: hochgeladener DateipfadEs enthält alle freigegebenen APIs