Skip to content
No description or website provided.
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
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.