lout

voyou

Générateur de documentation API pour HAPI

Description

Lout est un générateur de documentation pour les serveurs HAPI , fournissant un guide lisible par l'homme pour chaque point de terminaison à l'aide de la configuration de l'itinéraire. Le module permet une personnalisation complète de la sortie.

Démo en direct

Vous pouvez trouver une démo en direct de Lout en utilisant les routes de test unitaires. Les itinéraires sont bien sûr faux, mais vous pouvez comprendre à quoi ressemble LOUT compte tenu de diverses entrées.

Usage

Lout dépend de la vision et du inerte, assurez-vous de les enregistrer auprès de 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 )
) ; 

Paramètres

Les options suivantes sont disponibles lors de l'enregistrement du plugin:

• «moteurs» - un objet où chaque clé est une extension de fichier (par exemple «html», «jade»), mappée au nom du module NPM (chaîne) utilisé pour rendre les modèles. La valeur par défaut est {html: 'guidon'}.
• «Point de terminaison» - Le chemin où l'itinéraire sera enregistré. La valeur par défaut est / docs.
• «BASEPATH» - Le chemin absolu vers le dossier des modèles. La valeur par défaut est le dossier des modèles Lout.
• «CSSPATH» - Le chemin absolu vers le dossier CSS. La valeur par défaut est le dossier Lout CSS. Il doit contenir un style.css.
• «HEARTERSPATH» - Le chemin absolu vers le dossier des aides. La valeur par défaut est le dossier Lout Aiders.
• «PartialSpath» - Le chemin absolu vers le dossier partiel. La valeur par défaut est le dossier des modèles Lout. Cela pourrait devoir être nul si vous changez le chemin de base.
• «Auth» - la configuration de l'itinéraire pour l'authentification. La valeur par défaut est de désactiver l'auth.
• «Indextemplate» - le nom du fichier de modèle pour contenir la page principale des documents. La valeur par défaut est «index».
• «RouteTemplate» - le nom du fichier de modèle d'itinéraire. La valeur par défaut est «route».
• «FilterRoutes» - une fonction qui reçoit une method et path contenant un objet d'itinéraire et renvoie une valeur booléenne pour exclure les itinéraires.
• «Apiversion» - une chaîne facultative représentant la version API qui serait affichée dans la documentation.

Ignorer un itinéraire dans la documentation

Si vous souhaitez qu'une route spécifique n'apparaît pas dans la documentation de LOT, vous devez définir des paramètres LOT pour cette route spécifique vers FALSE.

Voici un exemple d'extrait d'une configuration d'itinéraire:

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

Si vous souhaitez exclure plusieurs itinéraires à l'aide de conditions, vous pouvez utiliser filterRoutes lors de l'enregistrement de 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 ) ;
    } ) ;
} ) ;