إجابة مباشرة
يمكن التحقق من معلومات واجهة الأوامر API من خلال دمج (1) هرمية المصدر (المراجع الرسمية أولاً)، (2) اختبارات قابلة للتكرار باستخدام نفس الفرضيات، و(3) التحقق من القيود ومودات الفشل. لأن شروط البورصة/المكان، التكاليف، وقواعد المورد يمكن أن تتغير، يجب أن تعامل النتائج على أنها متغيرة وتتحقق فقط من الآليات التي décriteها الوثائق.
آلية أو تعريف
واجهة الأوامر API هي واجهة برمجية تتيح لنظام التداول تقديم وإدارة الأوامر. عادةً ما تشمل واجهة الأوامر API مفاهيم مثل إنشاء الأمر، تحديث حالة الأمر، تقارير التملؤ/التنفيذ، وتعديل أو إلغاء الأمر. يبدأ التحقق بفصل طبقتين:
- آليات الواجهة المستقرة: ما تقبله واجهة API وتهدره (على سبيل المثال، الحقول المطلوبة، أنواع البيانات، هيكل طلب/استجابة، المعرفات، وممرات الحالة المستندة).
- سلوك التنفيذ المتغير: ما يحدث بعد التقديم (على سبيل المثال، ما إذا كان الأمر يتم ملؤه فورًا، جزئيًا، لاحقًا، أو رفضه). حتى مع استخدام نفس الطلب، يمكن أن تختلف النتائج بسبب ظروف السوق، الرسوم، السيولة، التأخير، وقواعد الولاية.
بسبب اختلاف هذه الطبقات، فإن ادعاء مثل “سيتم ملء واجهة API فورًا” ليس خاصية واجهة API فقط؛ فهو يعتمد على ظروف متغيرة. ادعاء قابل للتحقق هو أوسع، مثل “يمكن لواجهة API إرجاع رمز حالة أو حقل معين عندما يتم رفض الأمر”، بشرط أن تصف الوثائق ذلك صراحة.
دليل أو مثال
استخدم سير عمل التحقق القابل للتكرار الذي يمكنك توثيقه وإعادة تشغيله.
-
تحقق من هرمية المصدر
- اعتمد على وثائق واجهة API الرسمية للمورد وأي سجلات تغييرات معروضة.
- إذا كان متاحًا، قارن مع إرشادات المنظم الرسمي أو شروط المنصة فقط للسياسة/القواعد، وليس لتعريفات الحقول الفنية.
-
قم بتثبيت فرضياتك
- اختر بيئة غير حية (رملية/مرحلة ما قبل الإنتاج) عندما يكون ذلك ممكنًا.
- حدد ما ستقارن: حقول حمل طلب، أنماط الاستجابة، ممرات الحالة، ورسائل الأخطاء.
- افترض عدم وجود ضمانات أسعار فورية؛ عالج النتائج الملاحظة على أنها “ما حدث تحت هذه الظروف”، وليس كدليل على الأداء المستقبلي.
-
قم بتشغيل حالات اختبار controlled
- مسار سعيد: قدم بنية أمر صالحة الحد الأدنى وتحقق من أن الاستجابة تحتوي على المعرفات المستندة (على سبيل المثال، معرف الأمر) وأن استعلامات الحالة اللاحقة تعكس دورة الحياة المستندة.
- تحقق من صحة الإدخال: اكتب عمدًا حقلًا مطلوبًا أو استخدم قيمة غير صالحة لتحقق من أن واجهة API ترده الشكل المستند للأخطاء (على سبيل المثال، رمز الخطأ والرسالة).
- تحقق من الاستمرارية (إذا تم الوثوق بها): كرر نفس الطلب وفقًا لقواعد الاستمرارية المستندة وتحقق مما إذا كان يتم منع التكرارات.
- Mode الفشل: حاول الإلغاء بعد التقديم وتأكد مما إذا كانت واجهة API ترده إقرار الإلغاء أو خطأ متوافق مع سلوك الحالة المستند.
-
قارن الملاحظة مع المواصفات
- سجل حمل طلب/استجابة الدقيق والعلامات الزمنية.
- تحقق من أن حقول واجهة API المستندة تظهر بالضبط كما هو موضح (الأسماء، الأنواع، والقيم المسموح بها)، وأن الحالات المستندة يمكن الوصول إليها تحت اختباراتك.
إذا لم يكن claim “فنيًا” قابلًا للتكرار في اختباراتك controlled (على سبيل المثال، لا يظهر حقل أبدًا أو لا يحدث ممر حالة مستند أبدًا)، عالج الوثائق على أنها غير مكتملة أو قديمة وتحقق مرة أخرى من الإصدار وسجل التغييرات.
القيود والمخاطر
هناك قيود مادية للتحقق:
- التنفيذ ليس بالكامل حتميًا. حتى مع نفس الكود والطلبات، يمكن أن يتغير سلوك التنفيذ المتغير بسبب ظروف السوق، سيولة المكان، التأخير، والتكاليف.
- الوثائق يمكن أن تخلف الواقع. قد يقوم المورد بتحديث السلوك دون أن تعكس اختباراتك تلك التغييرات ما لم تأكيد إصدارات واجهة API.
- الأمثلة التاريخية ليست ضمانات. لا تحدد عمليات الماضي في بيئة محددة كيف سيتصرف النظام لاحقًا.
- قيود الولاية والسياسة يمكن أن تؤثر على ما هو مسموح به، والذي يمكن أن يتغير بشكل مستقل عن آليات واجهة API.
مخاطرة عملية هي الثقة الزائدة في statement وثائقي يخلط الآليات مع فرضيات التنفيذ. لتقليل هذه المخاطرة، تحقق فقط من الأجزاء التي تصف الوثائق على أنها سلوك مستوى الواجهة.
التحقق أو السؤال التالي
لتحقق من معلومات واجهة الأوامر API، prioritize checks القابلة للتكرار للواجهة: الحقول المطلوبة، هيكل الاستجابة، ممرات دورة الحياة/الحالة المستندة، وسلوك الأخطاء المستند. ثم اختبر صراحة على الأقل mode فشل واحد (رفض، إدخال غير صالح، إلغاء، أو تنفيذ جزئي) لتأكيد ما تفعله واجهة API عندما لا تسير الأمور كما هو متوقع. إذا لم يمكن التحقق من claim تحت نفس الفرضيات المدرجة، سجل عدم التطابق وتحقق مرة أخرى من إصدار وثائق واجهة API وسجل التغييرات قبل استخدام المعلومات في أي تكامل.