api-middleware

Ein Sumor Cloud Tool.
Weitere Dokumentation
API Middleware ist eine 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 16.x oder höher.

Erforderliches modulares Node.JS ES

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 namens plus.js in Ihrem Projektordner api 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 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 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