api-middleware

Sumor Cloudのツール。
詳細なドキュメント API Middleware は Node.JS 用のミドルウェアです。
簡単に関数を API に公開し、パラメータを検証できます。

インストール

npm i @sumor/api-middleware --save

前提条件

Node.JS バージョン

Node.JS バージョン 16.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

コンテキスト

data

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

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

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

exposeApis

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