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

إنشاء خادم محاكاة Postman

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

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

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

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

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

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

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

  1. افتح Postman وانقر على استيراد.

  2. قم بالتحميل:

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

  3. من قائمة البيئة العلوية اليمنى، حدد بيئة خط أنابيب البيانات.

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

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

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. استبدل قيمة العنصر النائب:
# old
https://mock-server-url-from-postman.io

# new
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": "Event successfully received by mock server."
}
}

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

أزل رأسًا مطلوبًا أو عدّل نص JSON لتشغيل استجابة 400 Bad Request.

{
  "error": "invalid_format",
  "detail": "Missing or invalid 'timestamp' field. Expected ISO 8601 format."
}

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

sequenceDiagram
    participant Dev as Postman (User)
    participant Mock as Postman Mock Server
    participant Resp as Mock Response

    Dev->>Mock: POST /v1/streams/ingest
    Note right of Dev: Headers: Authorization, X-Stream-Id, Content-Type
    Mock-->>Resp: Simulate 200 or 400 JSON response
    Resp-->>Dev: Return response to Postman client

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

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

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

لماذا هذا مهم​

يمكّنك استخدام خوادم ومجموعات Postman الوهمية من:

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

الخطوات التالية​