api-middleware

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"
}

使用方法

基本的な使用方法

プロジェクトフォルダーapiにplus.jsというファイルを追加してください

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

[オプション] プロジェクトフォルダーapiにplus.jsonという名前の構成ファイルを追加してください

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

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')
})

index.jsを実行してください

node index.js

より多様な構成ファイルタイプ

yaml

構成ファイルを定義するためにyamlファイルを使用することができます。plus.jsonをplus.ymlに置き換えてください

name: plus
parameters:
  a:
    name: parameter a
    type: number
    length: 3
  b:
    name: parameter b
    type: number

config.js

構成ファイルでjs関数をサポートするために、config.jsファイルを使用することができます。plus.jsonをplus.config.jsに置き換えてください

export default {
  name: 'plus',
  parameters: {
    a: {
      name: 'parameter a',
      type: 'number',
      length: 3
    },
    b: {
      name: 'parameter b',
      type: 'number',
      rule: [
        {
          code: 'TOO_BIG',
          message: 'b should be less than 100',
          function: function (value) {
            return value < 100
          }
        }
      ]
    }
  }
}

パラメータールール

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

{
  "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が含まれます。