lout

patán

Generador de documentación de API para HAPI

Descripción

Lout es un generador de documentación para los servidores HAPI , que proporciona una guía legible por humanos para cada punto final utilizando la configuración de la ruta. El módulo permite la personalización completa de la salida.

Demostración en vivo

Puede encontrar una demostración en vivo de lout utilizando las rutas de pruebas unitarias. Las rutas son, por supuesto, falsas, pero puede comprender cómo se ve lo que parece dada varias entradas.

Uso

Lout depende de la visión y la inerte, asegúrese de registrarlos con 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 )
) ; 

Parámetros

Las siguientes opciones están disponibles al registrar el complemento:

• 'Motores' : un objeto donde cada clave es una extensión de archivo (por ejemplo, 'html', 'jade'), asignado al nombre del módulo NPM (cadena) utilizado para representar las plantillas. El valor predeterminado es {html: 'manillars'}.
• 'Punto final' : la ruta donde se registrará la ruta. El valor predeterminado es /documentos.
• 'BasePath' : el camino absoluto a la carpeta de plantillas. El valor predeterminado es la carpeta de plantillas de lout.
• 'CSSPATH' : el camino absoluto a la carpeta CSS. El valor predeterminado es la carpeta CSS LOUT. Debe contener un estilo.css.
• 'Helperspath' : el camino absoluto a la carpeta de ayuda. El valor predeterminado es la carpeta de ayudantes de lout.
• 'ParcialSpath' : el camino absoluto a la carpeta Parcials. El valor predeterminado es la carpeta de plantillas de lout. Esto podría necesitar ser nulo si cambia el basepath.
• 'Auth' : la configuración de ruta para la autenticación. El valor predeterminado es para deshabilitar Auth.
• 'Indextemplate' : el nombre del archivo de plantilla para contener la página principal de los documentos. El valor predeterminado es 'índice'.
• 'RutetEmplate' : el nombre del archivo de plantilla de ruta. El valor predeterminado es 'ruta'.
• 'FilterRoutes' : una función que recibe un objeto de ruta que contiene method y path y devuelve un valor booleano para excluir las rutas.
• 'Apiversion' : una cadena opcional que representa la versión API que se mostraría en la documentación.

Ignorando una ruta en la documentación

Si desea que una ruta específica no aparezca en la documentación de LOUT, debe establecer la configuración de lout para esta ruta específica a False.

Aquí hay un ejemplo de fragmento de configuración de ruta:

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

Si desea excluir múltiples rutas usando condiciones, puede usar filterRoutes al registrar el remo:

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