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

追加の構成ファイルタイプ

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