إنتقل إلى المحتوى الرئيسي

إنشاء خادم Postman Mock

يشرح هذا الدليل كيفية استخدام ملفات عينة Postman المتوفرة لإنشاء بيئة واجهة برمجة تطبيقات وهمية. ستقوم بمحاكاة نفس نقاط النهاية الموضحة في الوثائق — دون الحاجة إلى خلفية حية.

المتطلبات الأساسية​

  • Postman (إصدار سطح المكتب أو الويب)

  • ثلاثة ملفات JSON مضمنة في هذا المشروع:

    • DataPipeline-Environment.json: تحدد المتغيرات القابلة لإعادة الاستخدام مثل base_url و mock_base_url و api_token و stream_id.
    • DataPipeline-postman-collection.json: تحاكي واجهة برمجة تطبيقات Streaming Ingest API الواردة في الوثائق للاختبار الحقيقي أو المرحلي.
    • DataPipeline-MockServer-Collection.json: تهيئ الاستجابات الوهمية لنفس نقاط النهاية باستخدام خادم Postman Mock Server.

قم بتنزيل الملفات الثلاثة هنا: تنزيل ملفات Postman

1. استيراد الملفات إلى Postman​

  1. افتح Postman وانقر فوق استيراد (Import).

  2. حدد ملفات JSON التي تم تنزيلها:

    • المجموعتان (DataPipeline-postman-collection.json و DataPipeline-MockServer-Collection.json).
    • البيئة (DataPipeline-Environment.json).

  3. من قائمة البيئة في أعلى اليمين، حدد بيئة خط أنابيب البيانات (Data Pipeline Environment).

يجب أن ترى الآن:

  • وثائق خط أنابيب البيانات مشروع
  • خط أنابيب البيانات - مجموعة خادم محاكاة
  • بيئة خط أنابيب البيانات

2. إنشاء الخادم الوهمي​

  1. انتقل إلى Mock Servers في Postman.
  2. انقر فوق Create Mock Server.
  3. اختر Data Pipeline—Mock Server Collection.
  4. احتفظ بالإعدادات الافتراضية وانقر فوق Create Mock Server.

سيقوم Postman بإنشاء عنوان خادم وهمي فريد، على سبيل المثال:

https://a12b34cd-1234-5678.mock.pstmn.io

3. تحديث متغير البيئة​

  1. انتقل إلى Environments → Data Pipeline Environment.
  2. ابحث عن المتغير mock_base_url.
  3. استبدل قيمة العنصر النائب:
# قديم
https://mock-server-url-from-postman.io

# جديد
https://a12b34cd-1234-5678.mock.pstmn.io
  1. احفظ البيئة.

4. إرسال أول طلب وهمي​

  1. افتح POST /v1/streams/ingest داخل مجموعة الخوادم الوهمية (Mock Server Collection).
  2. تأكد من أن البيئة نشطة.
  3. انقر فوق إرسال (Send).

يجب أن ترى استجابة وهمية 200 OK:

{
  "status": "accepted",
  "ingested_bytes": 204,
  "stream_id": "demo-stream-001",
  "message": "تم استلام الحدث بنجاح بواسطة الخادم الوهمي."
}

5. اختبار استجابة الخطأ​

قم بإزالة رأس مطلوب أو تحرير نص JSON لتشغيل استجابة 400 طلب غير صالح (Bad Request).

{
  "error": "invalid_format",
  "detail": "حقل 'timestamp' مفقود أو غير صالح. التنسيق المتوقع هو ISO 8601."
}

6. التبديل بين الاختبار المباشر والاختبار الوهمي​

  • لاختبار الأمثلة "المباشرة"، استخدم DataPipeline-postman-collection.json مع {{base_url}}.
  • لاختبار محليًا أو دون اتصال بالإنترنت، استخدم DataPipeline-MockServer-Collection.json مع {{mock_base_url}}.
  • كلاهما يعتمد على نفس DataPipeline-Environment.json لإدارة المتغيرات.

يتيح لك ذلك اختبار أمثلة الوثائق وواجهة برمجة التطبيقات الوهمية دون تغيير عناوين URL يدويًا.

تصور تدفق الطلب​

sequenceDiagram
    participant Dev as Postman (مستخدم)
    participant Mock as خادم Postman الوهمي
    participant Resp as استجابة وهمية

    Dev->>Mock: POST /v1/streams/ingest
    Note right of Dev: الرؤوس: Authorization, X-Stream-Id, Content-Type
    Mock-->>Resp: محاكاة استجابة JSON 200 أو 400
    Resp-->>Dev: إرجاع الاستجابة إلى عميل Postman

أهمية ذلك​

يتيح لك استخدام خوادم Postman Mock ومجموعاتها ما يلي:

  • اتباع البرامج التعليمية وأمثلة واجهة برمجة التطبيقات (API) تمامًا كما هي مكتوبة.
  • التحقق من صحة تنسيقات الطلبات والاستجابات قبل النشر.
  • اختبار البيئات الحقيقية والمحاكاة باستخدام تكوين واحد.
  • تطوير الوثائق والتحقق منها جنبًا إلى جنب مع تصميم واجهة برمجة التطبيقات (API).