lout

Lout

Gerador de documentação da API para hapi

Descrição

Lout é um gerador de documentação para servidores HAPI , fornecendo um guia legível pelo homem para todos os pontos de extremidade usando a configuração de rota. O módulo permite a personalização total da saída.

Demoção ao vivo

Você pode encontrar uma demonstração ao vivo de Lout usando as rotas de testes de unidade. É claro que as rotas são falsas, mas você pode entender como Lout se parece com várias entradas.

Uso

Lout depende da visão e do inerte, certifique -se de registrá -los no 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

As seguintes opções estão disponíveis ao registrar o plug -in:

• 'Motores' - um objeto em que cada tecla é uma extensão de arquivo (por exemplo, 'html', 'jade'), mapeada para o nome do módulo NPM (string) usado para renderizar os modelos. O padrão é {html: 'handlebars'}.
• 'Endpoint' - o caminho em que a rota será registrada. Padrão IS /Docs.
• 'Basepath' - o caminho absoluto para a pasta de modelos. O padrão é a pasta Lout Models.
• 'CSSPATH' - O caminho absoluto para a pasta CSS. O padrão é a pasta Lout CSS. Ele deve conter um estilo.css.
• 'HelphersPath' - O caminho absoluto para a pasta Helphers. O padrão é a pasta Lout Helpers.
• 'Parcialspath' - o caminho absoluto para a pasta parcials. O padrão é a pasta Lout Models. Isso pode precisar ser nulo se você mudar o Basepath.
• 'Auth' - a configuração da rota para autenticação. O padrão é desativar a autenticação.
• 'Indextemplate' - o nome do arquivo de modelo para conter a página principal dos documentos. O padrão é 'índice'.
• 'RouteTemplate' - o nome do arquivo de modelo de rota. O padrão é 'rota'.
• 'FilterRoutes' - uma função que recebe um objeto de rota que contém method e path e retorna um valor booleano para excluir rotas.
• 'APIVERSION' - Uma sequência opcional que representa a versão da API que seria exibida na documentação.

Ignorando uma rota na documentação

Se você deseja que uma rota específica não apareça na documentação de Lout, precisará definir configurações de Lout para esta rota específica como falsa.

Aqui está um exemplo de trecho de uma configuração de rota:

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

Se você deseja excluir várias rotas usando condições, pode usar filterRoutes ao registrar 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 ) ;
    } ) ;
} ) ;