lout

Lout

HAPI的API文档生成器

描述

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

参数

注册插件时可用以下选项：

• “引擎” - 每个键是文件扩展名（例如html'，'jade'）的对象，映射到用于渲染模板的NPM模块名称（字符串）。默认值为{html：'车把'}。
• “端点” - 路由注册的路径。默认值为 /文档。
• “ basepath” - 模板文件夹的绝对路径。默认值是Lout模板文件夹。
• “ CSSPATH” - CSS文件夹的绝对路径。默认值是Lout CSS文件夹。它必须包含style.css。
• “ helperspath” - 助手文件夹的绝对路径。默认值是Lout帮助者文件夹。
• “ partialspath” - 部分文件夹的绝对路径。默认值是Lout模板文件夹。如果您更改基地，这可能需要无效。
• “ auth” - 身份验证的路由配置。默认值是禁用auth。
• “ iNdextemplate” - 包含文档主页的模板文件的名称。默认值为“索引”。
• 'RuteTemplate' - 路由模板文件的名称。默认值为“路由”。
• “ FilterRoutes” - 接收包含method和path路由对象并返回布尔值以排除路由的函数。
• “ apiversion” - 代表文档中将显示的API版本的可选字符串。

忽略文档中的路线

如果您希望特定的路由不出现在Lout的文档中，则必须将此特定路线的Lout设置设置为False。

这是路由配置的示例片段：

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

如果要使用条件排除多个路线，则可以在注册Lout时使用filterRoutes ：

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