الواجهات الموجودة فقط في مخطط OpenAPI المنشور حاليًا ضمن /api/v1/ يتم دعمها. عناوين URL للوحة المعلومات ليست عامة API.
العقد أولا
خذ نقاط النهاية والأساليب والحقول والأذونات والحدود من OpenAPI؛ لا تخترع أبدًا نقطة نهاية غير موثقة.
المصادقة
استخدم HTTPS والرمز المميز ذي النطاق الأقل امتيازًا. لا تضعه أبدًا في عنوان URL أو حزمة متصفح أو Git.
يكتب آمنة
استخدم مفتاح العجز عند الحاجة، واحتفظ بمعرف الارتباط وأعد قراءة الحالة النهائية بعد انتهاء المهلة.
أخطاء
التعامل مع رموز الحالة وشكل الاستجابة المحدد بواسطة المخطط؛ احتفظ بالتفاصيل الحساسة في سجلات الخادم المرتبطة.
