البرنامج الوسيط لواجهة برمجة التطبيقات

أداة Sumor Cloud.
المزيد من الوثائق

البرنامج الوسيط لواجهة برمجة التطبيقات هو وسيط لـ Node.JS. يمكنه بسهولة تعريض الوظائف لواجهة برمجة التطبيقات، والتحقق من صحة المعلمات

التثبيت

npm i @sumor/api-middleware --save

المتطلبات المسبقة

إصدار Node.JS

يتطلب إصدار Node.JS 18.x أو أعلى

يتطلب إصدار Node.JS ES

نظرًا لأن هذه الحزمة مكتوبة بتنسيق ES module، يرجى تغيير الكود التالي في ملف package.json الخاص بك:

{
  "type": "module"
}

الاستخدام

الاستخدام الأساسي

١. أضف ملفًا باسم plus.js في مجلد مشروعك api

export default async (context, req, res) => {
  const { data } = context
  const { a, b } = data
  return a + b
}

٢. [اختياري] أضف ملفًا باسم plus.json في مجلد مشروعك api

{
  "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')
})

٤. قم بتشغيل index.js

node index.js

قاعدة المعلمة

يمكنك الرجوع إلى المثال أدناه لتطبيق قواعد على المعلمات

{
  "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": "must be greater than 0"
        }
      }
    },
    "b": {
      "name": "parameter b",
      "type": "number"
    }
  }
}

للمزيد من الاستخدام، يُرجى الرجوع إلى Validator

السياق

البيانات

تشمل جميع المعلمات المرسلة في الطلب

سيتم تحليل تحميل الملف ككائن أدناه:

• name اسم الملف المحمل
• size حجم الملف المحمل (بالبايت)
• mime نوع الملف المحمل (مثل image/png)
• encoding ترميز الملف المحمل (مثل 7bit)
• path مسار الملف المحمل

exposeApis

يشمل جميع الوظائف التي تمت تعريضها