sidinwillis / restify-swagger-jsdoc

Create Swagger documentation page based on jsdoc

restify-swagger-jsdoc

Create Swagger documentation page based on jsdoc

Installation

npm install restify-swagger-jsdoc --production

Initialization

To initialize the swagger JSDoc page, simply add this lines to the file that loads your restify server :

var restifySwaggerJsdoc = require('restify-swagger-jsdoc');
restifySwaggerJsdoc.createSwaggerPage({
    title: 'API documentation', // Page title (required)
    version: '1.0.0', // Server version (required)
    server: server, // Restify server instance created with restify.createServer()
    path: '/docs/swagger', // Public url where the swagger page will be available
    apis: [ `${__dirname}/controllers/*.js` ], // Path to the API docs
    definitions: {myObject: require('api/myObject.json')}, // External definitions to add to swagger (optional)
    routePrefix: 'prefix', // prefix to add for all routes (optional)
    forceSecure: false // force swagger-ui to use https protocol to load JSON file (optional, default: false)
});

With these settings, assuming that your server listens on port 80, the Swagger documentation page will be available at http://localhost/docs/swagger. The swagger.json file is available at http://localhost/docs/swagger/swagger.json.

How to document the API

This module is based on swagger-jsdoc, so you can refer to this module's documentation to document your API.