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 )
) ; 

พารามิเตอร์

ตัวเลือกต่อไปนี้พร้อมใช้งานเมื่อลงทะเบียนปลั๊กอิน:

• 'Engines' - วัตถุที่แต่ละคีย์เป็นส่วนขยายไฟล์ (เช่น 'HTML', 'Jade'), แมปกับชื่อโมดูล NPM (สตริง) ที่ใช้สำหรับการเรนเดอร์เทมเพลต ค่าเริ่มต้นคือ {html: 'handlebars'}
• 'จุดสิ้นสุด' - เส้นทางที่จะลงทะเบียนเส้นทาง ค่าเริ่มต้นคือ /เอกสาร
• 'Basepath' - เส้นทางที่แน่นอนไปยังโฟลเดอร์เทมเพลต ค่าเริ่มต้นคือโฟลเดอร์แม่แบบ lout
• 'CSSpath' - เส้นทางที่แน่นอนไปยังโฟลเดอร์ CSS ค่าเริ่มต้นคือโฟลเดอร์ Lout CSS มันต้องมี style.css
• 'Helferspath' - เส้นทางที่แน่นอนไปยังโฟลเดอร์ผู้ช่วย ค่าเริ่มต้นคือโฟลเดอร์ Lout Helpers
• 'PartialSpath' - เส้นทางที่แน่นอนไปยังโฟลเดอร์ Partials ค่าเริ่มต้นคือโฟลเดอร์แม่แบบ lout สิ่งนี้อาจต้องเป็นโมฆะถ้าคุณเปลี่ยน basepath
• 'Auth' - การกำหนดค่าเส้นทางสำหรับการตรวจสอบสิทธิ์ ค่าเริ่มต้นคือการปิดใช้งาน Auth
• 'indextemplate' - ชื่อของไฟล์เทมเพลตที่จะมีหน้าหลักเอกสาร ค่าเริ่มต้นคือ 'ดัชนี'
• 'RouteTemplate' - ชื่อของไฟล์เทมเพลตเส้นทาง ค่าเริ่มต้นคือ 'เส้นทาง'
• 'FilterRoutes' - ฟังก์ชั่นที่ได้รับวัตถุเส้นทางที่มี method และ path และส่งคืนค่าบูลีนเพื่อยกเว้นเส้นทาง
• 'Apiversion' - สตริงเสริมที่แสดงถึงเวอร์ชัน API ที่จะแสดงในเอกสารประกอบ

ไม่สนใจเส้นทางในเอกสาร

หากคุณต้องการเส้นทางที่เฉพาะเจาะจงที่จะไม่ปรากฏในเอกสารของ Lout คุณต้องตั้งค่าการตั้งค่า lout สำหรับเส้นทางเฉพาะนี้เป็นเท็จ

นี่คือตัวอย่างตัวอย่างของการกำหนดค่าเส้นทาง:

 {
  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 ) ;
    } ) ;
} ) ;