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()

await apiMiddleware(app, process.cwd() + '/api')

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000')
})

index.js を実行します。

node index.js

API をテストします。

curl -X POST http://localhost:3000/plus -H "Content-Type: application/json" -d '{"a": 1, "b": 2}'

またはブラウザを使用して http://localhost:3000/plus?a=1&b=2 を開きます。

apiMiddleware のオプション

import express from 'express'
import apiMiddleware from '@sumor/api-middleware'

const app = express()

await apiMiddleware(app, process.cwd() + '/api', {
  prefix: '/api',
  prepare: async context => {
    // API 前に何かを行う
  },
  finalize: async (context, result) => {
    // API 後に何かを行う
  },
  exception: async (context, error) => {
    // エラーを処理する
  }
})
app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000')
})

さらなる設定ファイルの種類

yaml

設定ファイルを定義するために yaml ファイルを使用できます。plus.json の代わりに plus.yml を使用します。

タイプはnumber、string、boolean、array、object のみをサポートします。

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 を参照してください。

context

data

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

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

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

exposeApis

すべての公開された API が含まれます。