api-middleware

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

Installation

npm i @sumor/api-middleware --save

Prérequis

Version de Node.JS

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

Requiert un module ES de Node.JS

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
}

[Facultatif] 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"
    }
  }
}

3. 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 tourne à l'adresse http://localhost:3000")
})

4. Exécutez index.js

node index.js

Contexte

data

Il inclut tous les paramètres transmis dans la requête

Le téléchargement de fichiers sera analysé comme un objet ci-dessous :

• name nom du fichier téléchargé
• size taille du fichier téléchargé (octets)
• mime type MIME du fichier téléchargé (par exemple, image/png)
• encoding encodage du fichier téléchargé (par exemple, 7bit)
• path chemin du fichier téléchargé

exposeApis

Il inclut toutes les APIs exposées