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 module، يرجى تغيير الكود التالي في ملف package.json الخاص بك:

{
  "type": "module"
}

الاستخدام

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

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

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

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

{
  "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 نوع الملف المحمل (مثلاً image/png)
• encoding ترميز الملف المحمل (مثلاً 7bit)
• path مسار الملف المحمل

exposeApis

يتضمن جميع الوظائف المكشوفة