Sumor Cloud ツール。
詳細なドキュメント
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()
apiMiddleware(app, process.cwd() + '/api')
app.listen(3000, () => {
console.log('サーバーが http://localhost:3000 で実行されています')
})
node index.js
config ファイルを定義するために 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 が含まれます。