الوصف
تمكّن Zudoku المطورين من صياغة توثيق API فائق الجودة من خلال منصتها مفتوحة المصدر والقابلة للتوسيع. تم تصميمها مع نهج يركز على المطورين، وهي تبسّط عملية إنشاء مواد مرجعية لـ API وبوابات مطورين نظيفة ومتناسقة وجذابة. تبسّط الأداة عملية تحويل مخططات OpenAPI v2/v3 إلى توثيق شامل، مع دعم كتالوجات API فردية ومتعددة.
البدء باستخدام Zudoku مصمم ليكون سريعًا وبديهيًا. يمكن للمستخدمين بدء مشروع جديد عبر سطر الأوامر باستخدام `npm create zudoku @latest`، متبوعًا بالتثبيت باستخدام `npm run zudoku install`. تتضمن الوظيفة الأساسية دمج مخطط OpenAPI الخاص بك في تكوين المشروع. تقوم Zudoku بعد ذلك بتوليد توثيق API تلقائيًا، مما يجعله متاحًا ومفهومًا للمستخدمين.
بالإضافة إلى التوليد التلقائي، تقدم Zudoku خيارات تخصيص قوية. يمكن للمطورين تخصيص شكل ومظهر توثيقهم باستخدام سمات مرنة ودعم MDX، مما يسمح بدمج ملفات markdown لتحسين محركات البحث (SEO) والأداء. يضمن هذا المرونة أن يتوافق التوثيق مع هوية العلامة التجارية واحتياجات المشروع المحددة.
تشمل الميزات الرئيسية بيئة تفاعلية لاختبار نقاط نهاية API مباشرة، مع دعم مفاتيح API والمصادقة. توفر Zudoku أيضًا إمكانيات بحث مدمجة، مدعومة بتقنيات مثل Pagefind و Inkeep، لاكتشاف المعلومات بشكل فوري وذكي. علاوة على ذلك، تدعم توليد المواقع الثابتة، مما يتيح نشر صفحات توثيق سريعة وصديقة لمحركات البحث يمكن استضافتها في أي مكان.
تم بناء Zudoku لتوسيع نطاقها وتعزيز التوثيق في سيناريوهات مختلفة. يتم تعزيز قابليتها للتوسيع بشكل أكبر من خلال الإضافات المعززة، مما يسمح بالتكامل السهل مع الأدوات الحالية وإنشاء وظائف مخصصة. المنصة مثالية لتوثيق واجهات برمجة التطبيقات الداخلية لتسريع سير عمل التطوير وبوابات المطورين المواجهة للجمهور. تلتزم Zudoku بتعزيز المجتمع، وتشجيع المساهمات والتعاون بين المطورين.
الميزات الأساسية لـ Zudoku
توليد توثيق API تلقائيًا من مخططات OpenAPI v2/v3
بيئة تفاعلية لـ API لاختبار نقاط النهاية مباشرة
دعم مدمج للمصادقة والترخيص (OAuth2, JWT)
وظيفة بحث فورية وذكية
توليد مواقع ثابتة لصفحات صديقة لمحركات البحث
تخصيص مرن مع السمات ودعم MDX
قابل للتوسيع مع الإضافات الأساسية والمجتمعية
يدعم كتالوجات API فردية ومتعددة
تصميم مفتوح المصدر ويركز على المطورين
ميزات تتبع وتصنيف كتالوج API
كيفية استخدام Zudoku؟
تثبيت CLI: قم بتشغيل `npm create zudoku @latest`
تهيئة المشروع: قم بتنفيذ `npm run zudoku install`
إضافة مخطط OpenAPI: قم بدمج مخططك في تكوين Zudoku
تخصيص المظهر: قم بتطبيق السمات و MDX للعلامة التجارية والأسلوب
اختبار نقاط النهاية: استخدم البيئة التفاعلية لاختبار API مباشرة
نشر التوثيق: قم بتوليد صفحات ثابتة للاستضافة في أي مكان
حالات استخدام Zudoku
- توثيق مرجع API
- بوابات المطورين
- توثيق API الداخلي
- كتالوجات API متعددة
- اختبار API التفاعلي
- توثيق يحمل العلامة التجارية
- توثيق مُحسّن لمحركات البحث
