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

Installation

npm i @sumor/api-middleware --save

Prérequis

Version de Node.JS

Nécessite la version de Node.JS 18.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 votre dossier de projet api

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

2. [Optionnel] Ajoutez un fichier nommé plus.json dans votre dossier de 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 fonctionne sur http://localhost:3000')
})

4. Exécutez index.js

node index.js

Règle des paramètres

Vous pouvez vous référer à l'exemple ci-dessous pour appliquer des règles aux paramètres

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "paramètre a",
      "type": "number",
      "length": 3,
      "rule": [
        {
          "code": "GREATER_THAN_0",
          "expression": "^[1-9][0-9]*$",
          "message": "doit être supérieur à 0"
        }
      ],
      "i18n": {
        "zh": {
          "GREATER_THAN_0": "doit être supérieur à 0"
        }
      }
    },
    "b": {
      "name": "paramètre b",
      "type": "number"
    }
  }
}

Pour plus d'utilisations, veuillez vous référer à Validator

context

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é (en octets)
• type type MIME du fichier téléchargé (par exemple, image/png)
• encodage encodage du fichier téléchargé (par exemple, 7bit)
• chemin chemin du fichier téléchargé

exposeApis

Il inclut toutes les APIs exposées