insomnia documenter
v0.5.5
مثل ساعي البريد الموثق ولكن للأرق! باستخدام هذه الأداة، يمكنك إنشاء صفحات وثائق API جميلة باستخدام ملف تصدير Insomnia الخاص بك.
العرض التوضيحي: https://insodoc.github.io/insomnia-documenter/
فيديو تعليمي وعرضي: https://www.youtube.com/watch?v=pq2u3FqVVy8
npxيقدم Insomnia Documenter أداة CLI لتسهيل إعداد صفحة التوثيق. يمكنك استخدامه بطريقتين.
npx npx insomnia-documenter --config /path/to/insomnia/config.jsonnpm i -g insomnia-documenter
insomnia-documenter --config /path/to/insomnia/config.json Options:
-c, --config <location> Location of the exported Insomnia JSON config.
-l, --logo <location> Project logo location (48x48px PNG).
-f, --favicon <location> Project favicon location (ICO).
-o, --output <location> Where to save the file (defaults to current working directory).
-h, --help output usage information
وبدلاً من ذلك، يمكنك البدء في استخدام Insomnia Documenter عن طريق تنزيل أرشيف الإصدار من GitHub وإضافة ملف التصدير insomnia.json إلى الدليل الجذر لموقعك.
يعد تحديث واجهة برمجة التطبيقات أمرًا بسيطًا للغاية! نظرًا لأن Insomnia Documenter هو تطبيق ويب للتوصيل والتشغيل، يمكنك فقط استبدال insomnia.json بملف JSON الجديد الذي تم تصديره. فقط تأكد من أنه يسمى insomnia.json .
وينطبق الشيء نفسه في الواقع على الشعار ( logo.png ) والأيقونة المفضلة ( favicon.ico ) أيضًا.
ربما تريد توثيق واجهات برمجة التطبيقات المتعددة على نفس المجال؟ ربما تريد استضافة صفحة التوثيق الخاصة بك على صفحات GitHub؟ في هذا (في العديد من الحالات الأخرى)، سوف تحتاج إلى تحديد المسار الجذري. للقيام بذلك، عليك فتح ملف index.html واستبدال السطر التالي:
< div id =" app " > </ div >بشيء مثل هذا:
< div id =" app " data-root =" /path/to/docs " > </ div > في هذه الحالة، سيلتقط التطبيق ملف insomnia.json من الدليل /path/to/docs . ويمنحك هذا مزيدًا من المرونة فيما يتعلق بالطريقة التي تريد بها صيانة صفحة الوثائق الخاصة بك (على سبيل المثال، يمكنك تخزين ملف التصدير في مكان آخر غير الدليل الجذر لصفحة الويب). يجب ألا تضع شرطة مائلة زائدة في خاصية data-root .
يرجى ملاحظة أن تعيين هذه السمة لن يؤثر على الأيقونة المفضلة وشعار الصفحة. وسيستمر تحميلها من نفس الدليل الذي يوجد به index.html .
سيفشل فتح ملف index.html في التحميل في 99.9% من الحالات لأن هذه هي الطريقة التي تعمل بها عملية الجلب. لمعاينة الصفحة محليًا، قد ترغب في استخدام أداة مثل zeit/serve:
npx serveستكون الصفحة متاحة على http://localhost:5000.
قام devhammed بإنشاء مكون Insomnia الإضافي الرائع الذي يسمح لك بإنشاء صفحة توثيق مباشرة من واجهة Insomnia. احصل على البرنامج المساعد (npm - جيثب)
يرجى الاطلاع على وثيقة سجل التغيير.
أداة CLI عبارة عن برنامج صغير للقائد، في حين أن الواجهة الأمامية نفسها عبارة عن تطبيق Svelte. هذا المشروع لا يزال في مرحلة تجريبية، مما يعني أنه يحتوي على أخطاء ويمكن تحسينه هنا وهناك. المساهمة هي موضع ترحيب :)
استنساخ المستودع:
git clone [email protected]:jozsefsallai/insomnia-documenter.git
cd insomnia-documenterتثبيت التبعيات:
npm installانسخ ملف التصدير التجريبي للأرق:
cp docs/insomnia.json public/insomnia.jsonقم بتشغيل بناء تطوير مع التحديث السريع:
npm run devإنشاء بناء الإنتاج:
npm run buildفحص:
npm run lintالاختبار:
npm run test معهد ماساتشوستس للتكنولوجيا.
ملحوظة: هذا المشروع غير تابع لكونج و/أو إنسومنيا.
متاح كجزء من اشتراك Tidelift
يعمل القائمون على Insomnia Documenter وآلاف الحزم الأخرى مع Tidelift لتقديم الدعم التجاري والصيانة للتبعيات مفتوحة المصدر التي تستخدمها لبناء تطبيقاتك. يمكنك توفير الوقت وتقليل المخاطر وتحسين سلامة التعليمات البرمجية، مع الدفع لمشرفي التبعيات الدقيقة التي تستخدمها. يتعلم أكثر.
