apeman-app-spec

apeman app to server OpenAPI document.


Keywords
apeman, app, spec
License
MIT
Install
npm install apeman-app-spec@2.0.0

Documentation

apeman-app-spec

Build Status Code Climate Code Coverage npm Version

apeman app to server OpenAPI document.

Installation

$ npm install apeman-app-spec --save

Usage

  1. Define an app within Apemanfile.js
  2. Call the app via apeman app command.

Apemanfile.js

/** This is an example Apemanfile to use apeman-app-spec */

'use strict'

module.exports = {
  $pkg: { /* ... */ },
  $apps: {
    // Define your own app.
    'my-app-01': {
      // Map url and handlers.
      '/': [
        require('apeman-app-spec')(
          'http://my-app/spec.json', // Swagger json url.
          {
            // Options
          }
        )
      ]
    }
  }
}

Then,

$ apeman app my-app-01 -p 3000

Signature

apemanAppSpec(options) -> function

apeman app to server OpenAPI document.

Args
Name Type Default Description
options object Optional settings.

License

This software is released under the MIT License.

Links