lout

Lümmel

API -Dokumentationsgenerator für HAPI

Beschreibung

LOUT ist ein Dokumentationsgenerator für HAPI -Server und bietet für jeden Endpunkt einen Human-Lesbaren-Leitfaden mit der Routenkonfiguration. Das Modul ermöglicht die vollständige Anpassung der Ausgabe.

Live -Demo

Sie können eine Live -Demo von Lockern mit den Routen der Unit -Tests finden. Die Routen sind natürlich falsch, aber Sie können das Verständnis dafür erhalten, wie LOUT bei verschiedenen Eingaben aussieht.

Verwendung

LOUT hängt von Vision und Inert ab. Stellen Sie sicher, dass Sie sie bei HAPI registrieren.

 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

Bei der Registrierung des Plugins sind die folgenden Optionen verfügbar:

• 'Engines' - Ein Objekt, bei dem jeder Schlüssel eine Dateierweiterung (z. B. 'HTML', 'Jade') ist, die dem NPM -Modulnamen (String) zugeordnet ist, der zum Rendern der Vorlagen verwendet wird. Standard ist {html: 'handbärchen'}.
• 'Endpoint' - Der Pfad, auf dem die Route registriert wird. Standard ist /docs.
• 'Basepath' - Der absolute Weg zum Vorlagenordner. Standard ist der Ordner lout templates.
• 'CSSpath' - Der absolute Weg zum CSS -Ordner. Standard ist der Lout CSS -Ordner. Es muss einen Stil enthalten.css.
• 'HelferPath' - Der absolute Weg zum Helferordner. Standard ist der Ordner lout helpers.
• 'partialSpath' - Der absolute Weg zum Partialsordner. Standard ist der Ordner lout templates. Dies muss möglicherweise null sein, wenn Sie den Basepath ändern.
• 'Auth' - Die Routenkonfiguration für die Authentifizierung. Standard ist, Auth zu deaktivieren.
• 'InDextemplate' - Der Name der Vorlagendatei zur Hauptseite der Dokumente. Standard ist 'Index'.
• 'routetemplate' - Der Name der Routenvorlagendatei. Standard ist 'Route'.
• 'filterroutes' - eine Funktion, die ein Routenobjekt mit method und path empfängt und einen booleschen Wert zurückgibt, um Routen auszuschließen.
• 'apiversion' - Eine optionale Zeichenfolge, die die API -Version darstellt, die in der Dokumentation angezeigt wird.

Ignorieren einer Route in Dokumentation

Wenn Sie möchten, dass eine bestimmte Route in LOUTs Dokumentation nicht angezeigt wird, müssen Sie LOUT -Einstellungen für diese spezielle Route auf False festlegen.

Hier ist ein Beispielausschnitt einer Routenkonfiguration:

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

Wenn Sie mehrere Routen mit Bedingungen ausschließen möchten, können Sie filterRoutes bei der Registrierung von LOUT verwenden:

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