api-middleware

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

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

CI
Test
Coverage
Audit

インストール

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('サーバーが http://localhost:3000 で実行中です')
})

4. 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が含まれます