Ein Sumor Cloud Tool.
Weitere Dokumentation
API Middleware ist ein Middleware für Node.JS. Es kann Funktionen einfach für die API 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
hinzu.export 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
hinzu.import 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. Ersetzen Sie plus.json
durch plus.yml
.
name: plus
parameters:
a:
name: Parameter a
type: number
length: 3
b:
name: Parameter b
type: number
Für die Unterstützung von JS-Funktionen in der Konfigurationsdatei können Sie eine 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 untenstehendes 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 Verwendungszwecke beachten Sie bitte Validator.
Sie enthält alle im Request übergebenen Parameter.
Dateiuploads werden als folgendes Objekt analysiert:
name
hochgeladener Dateinamesize
hochgeladene Dateigröße (Bytes)mime
hochgeladener Datei-MIME-Typ (z.B. image/png)encoding
hochgeladene Dateikodierung (z.B. 7bit)path
hochgeladener DateipfadEs enthält alle freigegebenen APIs.