Documented Connect/Express Router
JavaScript HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tests
.travis.yml
LICENSE
README.md
doc.jade
doc.pug
index.js
json2wadl.js
methods.js
package.json

README.md

DocRouter

Express router wrapper which exposes a formatted description of the available services of a server. The documentation is available is multiple formats (Html, Wadl, Json).

The usage mimics the regular router's behavior.

Retrieving the documentation

Two options:

Supported outputs

  • JSON (Accept: application/json)
  • WADL (Accept: text/xml)
  • HTML (Accept: text/html)

docRouter follows the RestDoc spec (https://github.com/RestDoc), RestDoc is a live spec so please expect changes over time.

Examples

var docRouter = require('docrouter').docRouter;
var app = express();
var router = express.Router();

docRouter(router, "http://myservice.mydomain.com");

router.get('/:app', handleGetApp,
    {
        id: "GetApp",
        doc: "Gets the app",
        params: {
            app: {
                style: "template",
                type: "string",
                required: true
            }
        }
    });

router.post('/:app', handleAddApp,
    {
        id: "UpdateApp",
        doc: "Updates the app",
        params: {
            app: {
                style: "template",
                type: "string",
                required: true
            }
        }
    });
    
app.use('/', router);
app.listen(5000);

Credits

License

MIT