lout

orang udik

Generator dokumentasi API untuk hapi

Keterangan

Lout adalah generator dokumentasi untuk server HAPI , memberikan panduan yang dapat dibaca manusia untuk setiap titik akhir menggunakan konfigurasi rute. Modul ini memungkinkan kustomisasi penuh output.

Demo langsung

Anda dapat menemukan demo langsung Lout menggunakan rute unit tes. Rute tentu saja palsu tetapi Anda bisa mendapatkan pemahaman tentang seperti apa kelihatannya diberikan berbagai input.

Penggunaan

Lout tergantung pada visi dan lembam, pastikan Anda mendaftarkannya dengan 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 )
) ; 

Parameter

Opsi berikut tersedia saat mendaftarkan plugin:

• 'Engine' - Objek di mana setiap kunci adalah ekstensi file (misalnya 'html', 'jade'), dipetakan ke nama modul NPM (string) yang digunakan untuk membuat templat. Default adalah {html: 'setang'}.
• 'Titik akhir' - Jalur di mana rute akan terdaftar. Default adalah /docs.
• 'Basepath' - Jalur absolut ke folder templat. Default adalah folder Lout Template.
• 'CSSPATH' - Jalur absolut ke folder CSS. Default adalah folder CSS Lout. Itu harus berisi style.css.
• 'HelterSpath' - Jalur absolut ke folder pembantu. Default adalah folder Lout Helters.
• 'PartialSpath' - Jalur absolut ke folder parsial. Default adalah folder Lout Template. Ini mungkin perlu nol jika Anda mengubah basepath.
• 'AUTH' - Konfigurasi Rute untuk Otentikasi. Default adalah menonaktifkan auth.
• 'Indextemplate' - Nama file template untuk berisi halaman utama Docs. Default adalah 'index'.
• 'RouteTemplate' - Nama file templat rute. Default adalah 'rute'.
• 'FilterRoutes' - Fungsi yang menerima metode rute yang berisi method dan path dan mengembalikan nilai boolean untuk mengecualikan rute.
• 'APIVERION' - String opsional yang mewakili versi API yang akan ditampilkan dalam dokumentasi.

Mengabaikan rute dalam dokumentasi

Jika Anda ingin rute tertentu tidak muncul dalam dokumentasi Lout, Anda harus menetapkan pengaturan Lout untuk rute khusus ini ke False.

Berikut adalah contoh cuplikan konfigurasi rute:

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

Jika Anda ingin mengecualikan beberapa rute menggunakan kondisi, Anda dapat menggunakan filterRoutes saat mendaftarkan 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 ) ;
    } ) ;
} ) ;