البدء في استخدام Postman مع API Discourse

[supermathie (Michael Brown)]

ملخص

Postman هي طريقة سهلة لإنشاء واختبار الطلبات ضد واجهة برمجة التطبيقات (API).

الإعداد مع Discourse

1. بعد فتح Postman، انقر فوق إنشاء مساحة عمل:

   

2. اختر مساحة عمل فارغة وانقر فوق التالي.

3. قم بتسميتها Discourse API وحدد إنشاء:

   

4. انقر فوق المجموعات:
   

   

5. انقر فوق استيراد:
   

   

6. الصق https://docs.discourse.org/openapi.json (وهو عنوان URL “التنزيل” المعروض على docs.discourse.org):
   

   

7. اختر الاستيراد كـ مجموعة Postman:
   

   

إنشاء بيئة جديدة

1. انقر فوق البيئات و إنشاء بيئة. سيحتوي هذا على متغيرات خاصة بالمثيل الذي تختبره. لهذا المثال، سنستخدم try.discourse.org.

   • أضف متغيرًا جديدًا: defaultHost بالقيمة try.discourse.org:
   • حدد بيئة try.discourse.org من القائمة المنسدلة للبيئة ⑤
   

مرحباً بالعالم!

دعنا نجرب طلبًا!

1. حدد المجموعات → categories.json → استرداد قائمة الفئات وانقر فوق إرسال. يجب أن ترى النتيجة:
   
   

إضافة المصادقة إلى الطلبات

لاستخدام واجهة برمجة التطبيقات مع مصادقة مفتاح واجهة برمجة التطبيقات:

1. أضف المتغيرات التالية إلى هذه البيئة أو بيئة جديدة:

   • api-username
   • api-key
   
   
   (يجب أن تكون قيمها صالحة بالطبع للموقع الذي تستعلم عنه)

2. أضف نصًا برمجيًا إلى المجموعة
   حدد المجموعات → Discourse API Documentation → النصوص البرمجية → قبل الطلب والصق ما يلي:

   pm.request.headers.add({
       key: "api-key",
       value: pm.variables.get("api-key")
   })
   pm.request.headers.add({
       key: "api-username",
       value: pm.variables.get("api-username")
   })