api-middleware

Ein Tool von Sumor Cloud.
Weitere Dokumentation

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

Installation

npm i @sumor/api-middleware --save

Voraussetzungen

Node.JS-Version

Benötigt Node.JS-Version 18.x oder höher

Erfordern von Node.JS ES-Modul

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

{
  "type": "module"
}

Verwendung

Grundlegende Verwendung

1. Füge eine Datei mit dem Namen plus.js in deinem Projektordner api hinzu

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

2. [Optional] Füge eine Konfigurationsdatei mit dem Namen plus.json in deinem Projektordner api hinzu

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

3. Füge den folgenden Code in deine index.js-Datei hinzu

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

4. Führe index.js aus

node index.js

5. Teste die API

curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'

oder öffne mit einem Browser http://localhost:3000/plus?a=1&b=2

Optionen für 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 auf http://localhost:3000')
})

Weitere Konfigurationsdateitypen

yaml

Du kannst eine YAML-Datei verwenden, um die Konfigurationsdatei zu definieren. Ersetze plus.json durch plus.yml

Der Typ unterstützt nur number, string, boolean, array, object

name: plus
parameters:
  a:
    name: Parameter a
    type: number
    length: 3
  b:
    name: Parameter b
    type: number

config.js

Um JS-Funktionen in der Konfigurationsdatei zu unterstützen, kannst du die Datei config.js verwenden. Ersetze 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
          }
        }
      ]
    }
  }
}

Parameterregel

Du kannst 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 Anwendungsbeispiele siehe Validator

Kontext

data

Es enthält alle im Request ü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 hochgeladener Dateikodierung (z.B. 7bit)
• path hochgeladener Dateipfad

exposeApis

Es enthält alle freigegebenen APIs