@sumor/api-middleware

api-middleware

Un outil Sumor Cloud.
Plus de Documentation API Middleware est un middleware pour Node.JS. Il peut facilement exposer des fonctions à une API et valider les paramètres

CI Test Coverage Audit

Installation

npm i @sumor/api-middleware --save

Prérequis

Version Node.JS

Nécessite la version Node.JS 16.x ou supérieure

require Node.JS ES module

Comme ce package est écrit en module ES, veuillez modifier le code suivant dans votre fichier package.json :

{
  "type": "module"
}

Utilisation

Utilisation de base

  1. Ajoutez un fichier nommé plus.js dans le dossier de votre projet api
export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

[Optionnel] 2. Ajoutez un fichier nommé plus.json dans le dossier de votre projet api

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "paramètre a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "paramètre b",
      "type": "number"
    }
  }
}
  1. Ajoutez le code suivant dans votre fichier index.js
import express from 'express'
import apiMiddleware from '@sumor/api-middleware'

const app = express()
apiMiddleware(app, process.cwd() + '/api')

app.listen(3000, () => {
  console.log('Le serveur fonctionne sur http://localhost:3000')
})
  1. Lancez index.js

    node index.js