Ein Sumor Cloud Tool.
Mehr Dokumentation
API Middleware ist ein Middleware für Node.JS. Es kann Funktionen leicht der API zugänglich machen 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,
bitte ändern Sie 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 hinzuimport express from 'express'
import apiMiddleware from '@sumor/api-middleware'
const app = express()
apiMiddleware(app, process.cwd() + '/api')
app.listen(3000, () => {
console.log('Server läuft auf http://localhost:3000')
})
node index.js
Sie können eine YAML-Datei verwenden, um die Konfigurationsdatei zu definieren, verwenden Sie anstelle von plus.json
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 eine config.js
-Datei verwenden, verwenden Sie anstelle von plus.json
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"
}
}
}
Für weitere Verwendungen, siehe Validator
Es enthält alle im Request übergebenen Parameter
Datei-Upload wird wie folgt analysiert:
name
Name der hochgeladenen Dateisize
Größe der hochgeladenen Datei (Bytes)mime
Mime-Typ der hochgeladenen Datei (z. B. image/png)encoding
Kodierung der hochgeladenen Datei (z. B. 7bit)path
Pfad der hochgeladenen DateiEs enthält alle ausgesetzten APIs