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 모듈 이름 (String)에 매핑됩니다. 기본값은 {html : 'handlebars'}입니다.
• '엔드 포인트' - 경로가 등록되는 경로. 기본값은 /문서입니다.
• 'Basepath' - 템플릿 폴더의 절대 경로. 기본값은 Lout Templates 폴더입니다.
• 'CSSPATH' - CSS 폴더의 절대 경로. 기본값은 Lout CSS 폴더입니다. Style.css를 포함해야합니다.
• 'Helperspath' - Helpers 폴더의 절대 경로. 기본값은 Lout Helpers 폴더입니다.
• 'partialSpath' - 부분 폴더의 절대 경로. 기본값은 Lout Templates 폴더입니다. Basepath를 바꾸면 무효가되어야 할 수도 있습니다.
• 'Auth' - 인증을위한 경로 구성. 기본값은 인증을 비활성화하는 것입니다.
• 'indextemplate' - 문서를 포함 할 템플릿 파일의 이름. 기본값은 '색인'입니다.
• 'LOTETEMPLATE' - 경로 템플릿 파일의 이름입니다. 기본값은 '경로'입니다.
• '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 ) ;
    } ) ;
} ) ;