عن المشروع

Ultralytics OpenAPI هي أداة تقرأ مواصفات OpenAPI (الإصدارات من 3.0 إلى 3.2.0) وتنتج مخرجين من عقد واحد: وثائق API تفاعلية وSDK مكتوب بلغة Python مع أنواع واضحة. وهي تدعم جميع عمليات HTTP القياسية (GET، POST، PUT، PATCH، DELETE، OPTIONS، HEAD، TRACE). يتم التكوين من خلال ملف `openapi.config.json`، حيث تحدد المصدر (ملف محلي أو عنوان URL)، واسم الحزمة المتولدة، ومتغير بيئة مفتاح API، ومسار قاعدة الوثائق، وبيانات وصفية متنوعة لحزمة Python (المؤلفون، المصنفات، الإصدار، الترخيص، إلخ). تدعم الأداة أيضًا توليد واجهة سطر أوامر اختيارية من خلال تضمين ملف مصدر Python يملكه المستهلك. تشمل الميزات الرئيسية: - عملاء Python متزامنون وغير متزامنون - موارد مكتوبة واستجابات TypedDict - دعم تحميل متعدد الأجزاء - إعادة محاولات تلقائية للفشل المؤقت - أخطاء API منظمة - معالجة مفتاح API تبقى في ذاكرة المتصفح للوثائق - بناء وثائق ثابتة حتمية - علامة تجارية قابلة للتخصيص (الشعار، الأيقونة، رموز التدرج) - وحدة مزود مصادقة اختيارية لاكتشاف بيانات الاعتماد المخصصة تستخدم SDKs المتولدة ترخيص AGPL-3.0 افتراضيًا ولكن يمكن تكوينها. يُطور المشروع باستخدام Bun وuv، ويتضمن أوامر للتطوير والاختبار والتوليد. تُخطط SDKs مستقبلية للغات TypeScript وGo وJava.