lout

lout

مولد توثيق API لـ Hapi

وصف

Lout هو مولد توثيق لخوادم HAPI ، ويوفر دليلًا قابل للقراءة للإنسان لكل نقطة نهاية باستخدام تكوين المسار. تتيح الوحدة التخصيص الكامل للإخراج.

عرض مباشر

يمكنك العثور على عرض تجريبي مباشر لـ Lout باستخدام طرق اختبارات الوحدة. بالطبع مزيفة بالطبع ولكن يمكنك الحصول على فهم لما يبدو عليه Lout في إعطاء مدخلات مختلفة.

الاستخدام

يعتمد Lout على الرؤية والخاملة ، تأكد من تسجيلها في Hapi.

 const Hapi = require ( 'hapi' ) ;

const server = Hapi . server ( { port : 80 } ) ;

await server . register ( [ require ( 'vision' ) , require ( 'inert' ) , require ( 'lout' ) ] ) ;

server . start ( ) . then (
  console . log ( 'Server running at:' , server . info . uri )
) ; 

حدود

تتوفر الخيارات التالية عند تسجيل البرنامج المساعد:

• "المحركات" - كائن حيث يكون كل مفتاح هو امتداد ملف (على سبيل المثال "HTML" ، "Jade") ، تم تعيينه إلى اسم وحدة NPM (السلسلة) المستخدمة لتقديم القوالب. الافتراضي هو {html: 'Handlebars'}.
• "نقطة النهاية" - المسار الذي سيتم فيه تسجيل المسار. الافتراضي هو /مستندات.
• "Basepath" - المسار المطلق إلى مجلد القوالب. الافتراضي هو مجلد قوالب Lout.
• "CSSPATH" - المسار المطلق إلى مجلد CSS. الافتراضي هو مجلد Lout CSS. يجب أن تحتوي على نمط.
• "Phixerspath" - المسار المطلق إلى مجلد المساعدين. الافتراضي هو مجلد مساعدين Lout.
• 'partialspath' - المسار المطلق إلى مجلد partials. الافتراضي هو مجلد قوالب Lout. قد يلزم أن يكون هذا فارغًا إذا قمت بتغيير BasePath.
• "Auth" - تكوين المسار للمصادقة. الافتراضي هو تعطيل Auth.
• "indextemplate" - اسم ملف القالب لاحتواء الصفحة الرئيسية للمستندات. الافتراضي هو "الفهرس".
• "RoutEtemplate" - اسم ملف قالب الطريق. الافتراضي هو "الطريق".
• "filterroutes" - وظيفة تتلقى كائن مسار يحتوي على method path وإرجاع قيمة منطقية لاستبعاد الطرق.
• "Apiversion" - سلسلة اختيارية تمثل إصدار API الذي سيتم عرضه في الوثائق.

تجاهل طريق في الوثائق

إذا كنت ترغب في عدم ظهور مسار معين في وثائق Lout ، فيجب عليك تعيين إعدادات LOUT لهذا المسار المحدد إلى FALSE.

فيما يلي مقتطف مثال لتكوين الطريق:

 {
  method : 'GET' ,
  path : '/myroute' ,
  options : {
    handler : [ ... ] ,
    [ ... ]
    plugins : {
      lout : false
    }
  }
}

إذا كنت ترغب في استبعاد طرق متعددة باستخدام الظروف ، فيمكنك استخدام filterRoutes عند تسجيل Lout:

 server . register ( [ require ( 'vision' ) , require ( 'inert' ) , {
  plugin : require ( 'lout' ) ,
  options : {
    filterRoutes : ( route ) => {
      return route . method !== '*' && ! / ^/private/ / . test ( route . path ) ;
    }
  }
} ] ) . then ( ( ) => {
    server . start ( ( ) => {
        console . log ( 'Server running at:' , server . info . uri ) ;
    } ) ;
} ) ;