توثيق واختبار واجهة برمجة التطبيقات من حالات الاستخدام الخاصة بها

اختر المهام قبل العناوين

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

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

وصف عقد صريح

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

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

اختبار الحدود والأذونات

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

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

خطة التغيير والدعم

تميز حقلًا مضافًا من حقل تمت إزالته أو معنى متغير. تحديد المستهلكين قبل تغيير غير متوافق. اشرح الفترة الانتقالية وكيفية اكتشاف عمليات التكامل التي لا تزال تستخدم العقد السابق.

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

التوثيق الأساسي: مبادرة OpenAPI - المواصفات.