api-middleware

Ein Sumor Cloud Tool.
Weitere Dokumentation

API Middleware ist ein Middleware für Node.JS. Es kann Funktionen einfach für APIs freigeben und Parameter validieren.

Installation

npm i @sumor/api-middleware --save

Voraussetzungen

Node.JS-Version

Erfordert Node.JS-Version 18.x oder höher.

Node.JS ES-Modul erforderlich

Da dieses Paket in ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json-Datei:

{
  "type": "module"
}

Verwendung

Grundverwendung

1. Fügen Sie eine Datei mit dem Namen plus.js in Ihrem Projektordner api hinzu

export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

2. [Optional] Fügen Sie eine Datei mit dem Namen plus.json in Ihrem Projektordner api hinzu

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "Parameter a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "Parameter b",
      "type": "number"
    }
  }
}

3. Fügen Sie den folgenden Code in Ihre index.js-Datei ein

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 unter http://localhost:3000')
})

4. Führen Sie index.js aus

node index.js

Parameterregel

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": "必须大于0"
        }
      }
    },
    "b": {
      "name": "Parameter b",
      "type": "number"
    }
  }
}

Für weitere Verwendungsmöglichkeiten siehe Validator

Kontext

Daten

Es enthält alle in der Anfrage übergebenen Parameter

Datei-Upload wird als folgendes Objekt analysiert:

• name: hochgeladener Dateiname
• size: hochgeladene Dateigröße (Bytes)
• mime: hochgeladener Datei-MIME-Typ (z. B. image/png)
• encoding: hochgeladene Dateikodierung (z. B. 7bit)
• path: hochgeladener Dateipfad

exposeApis

Es enthält alle freigegebenen APIs