@studiohyperdrive/api-docs
Studio Hyperdrive API docs npm package
Last updated a year ago by ex03495 .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @studiohyperdrive/api-docs 
SYNC missed versions from official npm registry.

Node.js API Docs

Simple Node.js package which exposes Swagger docs both in JSON and HTML.

Installation

$ npm install -S @studiohyperdrive/api-docs

Setup

app.use(docs({
    name: "my-api",
    version: "1.0.0",
    baseUrl: "/",
    path: "path/to/docs/folder/",
    basePath: "/v1",
    host: "studiohyperdrive.be",
    schemes: ["https", "http"],
    NODE_ENV: [
        "development"
    ]
}));

Configuration

  • name
    • Name of the API.
    • Defaults to the package.json name.
  • description
    • Description of the API.
    • Defaults to the package.json description.
  • version
    • Version of the API.
    • Defaults to the package.json version.
  • baseUrl
    • All routes will be prefixed with this value.
    • Defaults to "/".
  • path
    • Path (starting from the root) where all the docs can be found.
    • Package will search for Swagger docs in folder and nested folders.
  • NODE_ENV
    • Package exposes two routes only in specific NODE_ENV's.
  • host
    • host is the domain name or IP address (IPv4) of the host that serves the API.
    • Empty by default.
  • basePath
    • basePath is the URL prefix for all API paths, relative to the host root. It must start with a leading slash /.
    • Defaults to "/".
  • schemes
    • schemes are the transfer protocols used by the API. Swagger supports the http, https, and WebSocket schemes – ws and wss.
    • Defaults to "https".

Usage

Swagger docs will be available on these routes:

(Replace https://my-own-url.com with your domain. baseUrl is optional depending on your config.)

Current Tags

  • 1.1.0                                ...           latest (a year ago)

5 Versions

  • 1.1.0                                ...           a year ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.0.2                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 1
Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |