Nightly Procrastination Machine
Wondering what’s next for npm?Check out our public roadmap! »

@boundstate/hapi-api-docsTypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

hapi-api-docs

Resonsive Swagger documentation for Hapi.

Built using hapi-swagger and jensoleg/swagger-ui.

Usage

npm install @boundstate/hapi-api-docs
import * as Hapi from 'hapi';
import {hapiApiDocs} from '@boundstate/hapi-api-docs';
 
const server = new Hapi.Server();
 
server.register({
  register: hapiApiDocs,
  options: {
    basePath: '/',
    pkg: require('../package.json'),
    schemes: ['http'],
  },
}).then((err) => {
 
});

Tag the routes you wish to document with api.

Access the documentation at /documentation/.

Keywords

none

Install

npm i @boundstate/hapi-api-docs

DownloadsWeekly Downloads

2

Version

0.0.2

License

none

Last publish

Collaborators

  • avatar
  • avatar