Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

swaggerize-hapi

krakenjs309Apache-2.04.2.1

Design-driven apis with OpenAPI (swagger) 2.0 and hapi.

openapi, swagger, swagger 2.0, swagger-node, swagger-express, swagger-ui, swagger-hapi, swaggerize, hapi, rest, restful, service, api

readme

swaggerize-hapi

This module has been renamed. Please use hapi-openapi instead.

changelog

4.2.0

  • Delegating to hapi-openapi.

4.1.0

  • Fixes trailing spaces #104.
  • Fixes empty base path #106.
  • Fixes no operation parameters #108.
  • Adds support for API as object instead of file path #102

4.0.0

  • [BREAKING] x-* attribute support renamed to x-hapi-*.
  • New support for x-hapi-options on operations.

3.4.2

  • Updated to file validation which addresses #68.

3.4.1

  • Upgraded enjoi.

3.4.0

  • Added support for output validation (optional).

3.3.2

  • Fixed YAML parsing for api-docs route.

3.3.1

3.3.0

  • x-auth attribute support.
  • basedir is not an option (officially).

3.2.0

  • x-handler attribute support.

3.1.0

  • Add tags and description to routes based on API spec.
  • Don't restrict auth types.
  • Add route meta data from API spec.
  • docspath option is now docs and is an object.

3.0

  • [BREAKING] Migrated to Hapi 17 and Node 8.
  • [BREAKING] Severed from swaggerize-routes - this module is now standalone.
  • [BREAKING] server.plugins.swagger.api is now server.plugins.swagger.getApi().
  • [BREAKING] handlers object doesn't namespace http methods using $ anymore. Assumption is verb is last in object path.
  • [BREAKING] Currently does not work with the swaggerize-generator.
  • Routes will specify what they allow based on api spec.