بناء وتكوين أداة

ابدأ بوثائق واجهة برمجة التطبيقات (API) الرسمية لخدمة الأعمال والمهمة التي يُسمح لحسابك بتنفيذها. من السهل اختبار أداة واحدة ضيقة وموصوفة جيدًا من أداة عامة تقبل عنوان URL وطريقة عشوائية.

تحديد الطلب#

امنح الأداة اسمًا ثابتًا ووصفًا يوضح الغرض منها والحدود المهمة وما إذا كانت تغير البيانات. حدد طريقة HTTP الموثقة ونقطة النهاية. استخدم العناصر النائبة فقط لعناصر المسار المتغير التي تسمح بها العملية بالفعل.

بالنسبة للبحث عن سجل وهمي، قد يحتوي المسار على معرف السجل. يجب أن يظل اسم المضيف ومنطقة الحساب جزءًا من الاتصال الذي تم تكوينه بدلاً من إدخال النموذج المفتوح.

تحديد وتعيين المدخلات#

استخدم مخطط الإدخال لوصف كل حقل ونوعه والحالة المطلوبة والقيم الصالحة. مخطط صغير للبحث الخيالي هو:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

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

تشكيل الإخراج#

يمكن أن يؤدي تعيين الاستجابة أو تحويلها إلى إرجاع الحقول التي يحتاجها سير العمل بدلاً من استجابة الخدمة بأكملها. تحقق من الإخراج المحول مقابل نتيجة الاختبار الأصلية. لا تقم بإزالة معرف السجل أو معلومات ترقيم الصفحات أو تفاصيل الخطأ اللازمة لفهم ما إذا كانت النتيجة كاملة أم لا.

مراجعة إعدادات التشغيل#

يدعم تكوين الأداة إعدادات المهلة والتخزين المؤقت وإعادة المحاولة. استخدم التخزين المؤقت فقط عندما تكون البيانات القديمة مقبولة؛ القراءة المخزنة مؤقتًا غير مناسبة كدليل نهائي على أن الكتابة قد اكتملت للتو. يمكن أن تؤدي إعادة محاولة الكتابة غير الفعالة إلى إنشاء نسخ مكررة، لذا اختر سلوك إعادة المحاولة من الضمانات الموثقة لواجهة برمجة التطبيقات (API).

اختبار المسار الحقيقي#

تحقق من الإدخال الصحيح، والإدخال غير الصالح، والنتائج الفارغة، وفشل الإذن، ومكالمة ناجحة محدودة. قد تحتوي تشخيصات الاختبار على معلومات طلب حساسة؛ قم بفحصها فقط من خلال طريق المسؤول المعتمد وقم بتنقيحها قبل المشاركة. انظر اختبار قبل أن يستخدم العميل الأداة.