api-middleware

Ein Sumor Cloud Tool.
Weitere Dokumentation
API Middleware ist ein Middleware für Node.JS. Es kann Funktionen leicht für APIs freigeben und Parameter validieren.

CI
Test
Coverage
Audit

Installation

npm i @sumor/api-middleware --save

Voraussetzungen

Node.JS Version

Erfordert 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

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
}
[Optional] 2. 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 auf http://localhost:3000')
})
4. Führen Sie index.js aus
node index.js

Kontext

data

Enthält alle im Request übergebenen Parameter

Datei-Upload wird als folgendes Objekt analysiert:

exposeApis

Enthält alle freigegebenen APIs