الصفحة الرئيسية>PHP كود المصدر>فئات أخرى
تنزيل

مقدمة

APIDOC هو قالب مصنوع في HTML و PHP و JQUERY للمساعدة في وثائق PHP REST API.

تثبيت

انسخ الرابط أدناه إلى سطر الأوامر الخاص بك لتنزيل أحدث إصدار. لا تحتاج APIDOC إلى تثبيت على جهازك ، ما عليك سوى استنساخ الملف وفك ضغطه إلى مجلد الخادم. 

$ git clone -b 2.0.0-stable --single-branch https://github.com/brennoDuarte/ApiDoc.git ApiDoc-v2.0.0-stable

تأكد من تمكين JavaScript في متصفحك. يمكنك تشغيل الوضع المظلم ، ولكن سيتم إيقاف تشغيله بمجرد إعادة تحميل الصفحة.

تكوين

ملفات JSON موجودة في مجلد "JSON".

يمكنك تحرير الملف "config.json" على النحو التالي:

  • "appname" : اسم مشروعك ،
  • "الإصدار" : إصدار المشروع الخاص بك ،
  • "الوصف" : وصف موجز لواجهة برمجة التطبيقات الخاصة بك ،
  • "لغة" : اللغة التي صنعت بها واجهة برمجة التطبيقات الخاصة بك ،
  • "بروتوكول" : بروتوكول واجهة برمجة التطبيقات ، HTTP أو HTTPS ،

لتحرير الطرق الافتراضية ، قم بتغيير ملف "Router.json". تنقسم جلسة URLS إلى:

  • "PathName" : اسم المسار الرئيسي من نقطة النهاية الخاصة بك ،
  • "ID" : معرف مشروط سيتم عرضه بالنقر فوق الزر Route. تذكر تحرير معرف مختلف لكل نقطة نهاية ، وإلا فلن يتم عرض المعرف ،
  • "Epateget/getid/post/put/delete" : نقاط نهاية واجهة برمجة التطبيقات الخاصة بك ،
  • "Descriptionget/post/put/delete" : وصف موجز لنقطة النهاية الخاصة بك ،
  • "الرابط" : رابط من نقطة النهاية الخاصة بك. سيتم فتح النقر فوقه في علامة تبويب جديدة.

لإضافة مسار جديد ، انسخ من "PathName" إلى ملف "config.json" ولصقه أسفل المسارات الأخرى.

إذا كان لديك طرق متعددة (احصل ، نشر ، وضع ، حذف) ، استخدم مسارًا مخصصًا. يمكنك تحرير ملف customRouter.json لهذا:

  • "CustomRouter" : اسم المسار الرئيسي من نقطة النهاية الخاصة بك ،
  • "النوع" : احصل ، نشر ، وضع ، حذف أو غيره ،
  • "المسار" : نقطة نهاية واجهة برمجة التطبيقات الخاصة بك ،
  • "الوصف" : وصف موجز لنقطة النهاية الخاصة بك ،
  • "الرابط" : رابط من نقطة النهاية الخاصة بك. سيتم فتح النقر فوقه في علامة تبويب جديدة.

إذا لم يكن لدى API طلب معين ، فقم بتغيير الحقل إلى NULL. مثال: 

 " post " : {
    " id " : null,
    " pathPost " : null,
    " descriptionPost " : null,
    " link " : null
},

تم ، فقط افتح ملف apidoc.php في أي تصفح.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل