api-middleware

Ein Sumor Cloud Tool.
Weitere Dokumentation
API Middleware ist ein Middleware für Node.JS.
Es ermöglicht das einfache Bereitstellen von Funktionen für APIs und die Validierung von Parametern.

Installation

npm i @sumor/api-middleware --save

Voraussetzungen

Node.JS Version

Benötigt Node.JS Version 16.x oder höher

Erforderliches Node.JS ES-Modul

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

{
  "type": "module"
}

Verwendung

Grundlegende Verwendung

1. Fügen Sie eine Datei namens plus.js im Ordner api Ihres Projekts hinzu

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

[Optional] 2. Fügen Sie eine Datei namens plus.json im Ordner api Ihres Projekts 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 Ihrer index.js-Datei 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 unter http://localhost:3000')
})

4. Führen Sie index.js aus

node index.js