Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript CSS
branch: master

fix extract of parameters

* support raw json swagger data
latest commit b3aa46c4e7
@outbounder authored
Failed to load latest commit information.
context
tests
.gitignore
README.md
index.js
package.json

README.md

organic-swaggerdocs

An expressjs middleware suitable to extract at runtime documentation found at folders containing expresshttpactions.

Can be used as middleware to organic-expressserver

The implementation is based on swagger UI and swagger core specification.

usage

via DNA middleware of expressserver

{
  "source": "node_modules/organic-swaggerdocs",
  "arguments": [{
    "mount": "/apidocs",
    "apiEndpoint": "/api",
    "dynamicDocumentation": "routes/api",
    "log": true
  }]
}

standalone

var express = require("express")
var app = express()
var swaggerdocs = require("organic-swaggerdocs")
swaggerdocs.call({
  app: app
}, {
  "mount": "/apidocs",
  "apiEndpoint": "/api",
  "dynamicDocumentation": "routes/api",
  "log": true
})
Something went wrong with that request. Please try again.