lout

накапливаться

API -документации генератор для HAPI

Описание

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 Templates.
• «CSSpath» - абсолютный путь к папке CSS. По умолчанию папка Lout CSS. Он должен содержать стиль. CSS.
• «Helperspath» - абсолютный путь к папке помощников. По умолчанию папка Lout Helpers.
• «Partialspath» - абсолютный путь к папке Partials. По умолчанию папка Lout Templates. Это может быть нулевым, если вы измените базовый тур.
• «Auth» - конфигурация маршрута для аутентификации. По умолчанию отключить аут.
• «Indextemplate» - Имя файла шаблона для содержания главной страницы DOCS. По умолчанию «индекс».
• «Routetemplate» - имя файла шаблона маршрута. По умолчанию «маршрут».
• «Filterroutes» - функция, которая получает объект маршрута, содержащий method и path , и возвращает логическое значение для исключения маршрутов.
• «Apiversion» - необязательная строка, представляющая версию API, которая будет отображаться в документации.

Игнорирование маршрута в документации

Если вы хотите, чтобы конкретный маршрут не появился в документации Lout, вам нужно установить настройки LOUT для этого конкретного маршрута для FALSE.

Вот пример фрагмента конфигурации маршрута:

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

Если вы хотите исключить несколько маршрутов, используя условия, вы можете использовать filterRoutes при регистрации 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 ) ;
    } ) ;
} ) ;