swagger-ui-http v1.1.1

swagger-ui-http

Swagger UI HTTP module.

Installation

npm install swagger-ui-http

Usage

When you require to usage of the swagger-ui-http module you must get the router first, indicating in the same moment the server name and the port number in which your application will be executed. The 'apis' parameter have to be defined with the file name list in which you have included endpoints within the router and you want them to be added equally in the Swagger UI display. Finally, within the parameter 'info' you could include all that predefined information, such as application configuration, version, url published and any other information relevant to your application, sensitive to be consulted at any time.

const host = 'servername.domain.com'
const port = 3000
const apis = ['./index.js']
const info = {
    appName: 'Swagger-UI-HTTP-Example',
    appVersion: '1.0.0',
    endpoints: {
        urlStatus: '/status'
    }
}

const router = require("swagger-ui-http").getRouter(host, port, apis, info)

const http = require("swagger-ui-http")

/**
 * @swagger
 * /status:
 *   get:
 *     tags:
 *       - status
 *     description: Return UP if the applications is running sucessfully.
 *     produces:
 *       - application/json
 *     responses:
 *       200:
 *         description: OK.
 */
router.addRoute(info.endpoints.urlStatus, (req, res, params) => http.sendJSONResponse(res, {status: http.getHTTP().STATUS.CODE.OK, body: { message: http.getHTTP().STATUS.CODE.MESSAGE } }))