api-middleware

Sumor Cloudツール。
詳細なドキュメント

API MiddlewareはNode.JS用のミドルウェアです。 簡単にAPIへの関数を公開し、パラメーターを検証できます。

インストール

npm i @sumor/api-middleware --save

必須条件

Node.JSバージョン

Node.JSバージョン18.x以上が必要です

Node.JS ESモジュールが必要

このパッケージはESモジュールで書かれているため、package.jsonファイル内の以下のコードを変更してください:

{
  "type": "module"
}

使用方法

基本的な使用方法

1. プロジェクトフォルダーapiにplus.jsというファイルを追加します

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

2. [オプション] プロジェクトフォルダーapiにplus.jsonというファイルを追加します

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parameter a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

3. 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('Server is running on http://localhost:3000')
})

4. index.jsを実行します

node index.js

パラメータールール

以下の例を参照して、パラメーターにルールを適用できます

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parameter a",
      "type": "number",
      "length": 3,
      "rule": [
        {
          "code": "GREATER_THAN_0",
          "expression": "^[1-9][0-9]*$",
          "message": "must be greater than 0"
        }
      ],
      "i18n": {
        "zh": {
          "GREATER_THAN_0": "必须大于0"
        }
      }
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

より詳しい使用方法については、Validatorを参照してください

コンテキスト

data

リクエストに渡されたすべてのパラメーターが含まれます

ファイルのアップロードは以下のオブジェクトとして解析されます:

• name アップロードされたファイルの名前
• size アップロードされたファイルのサイズ(バイト)
• mime アップロードされたファイルのMIMEタイプ(例: image/png)
• encoding アップロードされたファイルのエンコーディング(例: 7bit)
• path アップロードされたファイルのパス

exposeApis

公開されているすべてのAPIを含みます