api-middleware

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

CI
Test
Coverage
Audit

インストール

npm i @sumor/api-middleware --save

必要条件

Node.JS バージョン

Node.JS バージョン 16.x 以上が必要です。

Node.JS の ES モジュールが必要

このパッケージは ES モジュールで記述されていますので、
package.json ファイルで以下のコードを変更してください:

{
  "type": "module"
}

使用法

基本的な使用法

  1. プロジェクトフォルダー apiplus.js というファイルを追加してください。
export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

[オプション] 2. プロジェクトフォルダー apiplus.json というファイルを追加してください。

{
  "name": "plus",
  "parameters": {
    "a": {
      "name": "parameter a",
      "type": "number",
      "length": 3
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}
  1. 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')
})
  1. index.js を実行してください。

    node index.js