API Middleware は Node.JS 用のミドルウェアです。
関数を簡単にAPIに公開でき、パラメータを検証できます。
npm i @sumor/api-middleware --save
Node.JS バージョン 18.x 以上が必要です。
このパッケージは 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
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 ファイルを使用して構成ファイルを定義できます。plus.json
を plus.yml
に置き換えます。
name: plus
parameters:
a:
name: parameter a
type: number
length: 3
b:
name: parameter b
type: number
構成ファイルで 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 を参照してください。
リクエストで渡されたすべてのパラメータが含まれます。
ファイルのアップロードは以下のオブジェクトとして解析されます。
name
アップロードされたファイル名size
アップロードされたファイルのサイズ(バイト)mime
アップロードされたファイルの MIME タイプ(例:image/png)encoding
アップロードされたファイルのエンコーディング(例:7bit)path
アップロードされたファイルのパス公開されたすべての API が含まれます。