Namespace Pollution Mechanism
    Have ideas to improve npm?Join in the discussion! »

    swagger-ui-express
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/swagger-ui-express package

    4.1.6 • Public • Published

    Swagger UI Express

    This module allows you to serve auto-generated swagger-ui generated API docs from express, based on a swagger.json file. The result is living documentation for your API hosted from your API server via a route.

    Swagger version is pulled from npm module swagger-ui-dist. Please use a lock file or specify the version of swagger-ui-dist you want to ensure it is consistent across environments.

    You may be also interested in:

    • swagger-jsdoc: Allows you to markup routes with jsdoc comments. It then produces a full swagger yml config dynamically, which you can pass to this module to produce documentation. See below under the usage section for more info.
    • swagger tools: Various tools, including swagger editor, swagger code gen etc.

    Usage

    Install using npm:

    $ npm install swagger-ui-express

    Express setup app.js

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

    or if you are using Express router

    const router = require('express').Router();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    router.use('/api-docs', swaggerUi.serve);
    router.get('/api-docs', swaggerUi.setup(swaggerDocument));

    Open http://<app_host>:<app_port>/api-docs in your browser to view the documentation.

    If you want to set up routing based on the swagger document checkout swagger-express-router

    swagger-jsdoc

    If you are using swagger-jsdoc simply pass the swaggerSpec into the setup function:

    // Initialize swagger-jsdoc -> returns validated swagger spec in json format
    const swaggerSpec = swaggerJSDoc(options);
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

    Swagger Explorer

    By default the Swagger Explorer bar is hidden, to display it pass true as the 'explorer' property of the options to the setup function:

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    var options = {
      explorer: true
    };
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));

    Custom swagger options

    To pass custom options e.g. validatorUrl, to the SwaggerUi client pass an object as the 'swaggerOptions' property of the options to the setup function:

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    var options = {
      swaggerOptions: {
        validatorUrl: null
      }
    };
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));

    For all the available options, refer to Swagger UI Configuration

    Custom CSS styles

    To customize the style of the swagger page, you can pass custom CSS as the 'customCss' property of the options to the setup function.

    E.g. to hide the swagger header:

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    var options = {
      customCss: '.swagger-ui .topbar { display: none }'
    };
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));

    Custom CSS styles from Url

    You can also pass the url to a custom css file, the value must be the public url of the file and can be relative or absolute to the swagger path.

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    var options = {
      customCssUrl: '/custom.css'
    };
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));

    Custom JS

    If you would like to have full control over your HTML you can provide your own javascript file, value accepts absolute or relative path. Value must be the public url of the js file.

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    var options = {
      customJs: '/custom.js'
    };
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));

    Load swagger from url

    To load your swagger from a url instead of injecting the document, pass null as the first parameter, and pass the relative or absolute URL as the 'url' property to 'swaggerOptions' in the setup function.

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    
    var options = {
      swaggerOptions: {
        url: 'http://petstore.swagger.io/v2/swagger.json'
      }
    }
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(null, options));

    To load multiple swagger documents from urls as a dropdown in the explorer bar, pass an array of object with name and url to 'urls' property to 'swaggerOptions' in the setup function.

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    
    var options = {
      explorer: true,
      swaggerOptions: {
        urls: [
          {
            url: 'http://petstore.swagger.io/v2/swagger.json',
            name: 'Spec1'
          },
          {
            url: 'http://petstore.swagger.io/v2/swagger.json',
            name: 'Spec2'
          }
        ]
      }
    }
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(null, options));

    Make sure 'explorer' option is set to 'true' in your setup options for the dropdown to be visible.

    Load swagger from yaml file

    To load your swagger specification yaml file you need to use a module able to convert yaml to json; for instance yamljs.

    npm install --save yamljs
    
    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const YAML = require('yamljs');
    const swaggerDocument = YAML.load('./swagger.yaml');
    
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

    Modify swagger file on the fly before load

    To dynamically set the host, or any other content, in the swagger file based on the incoming request object you may pass the json via the req object; to achieve this just do not pass the the swagger json to the setup function and it will look for swaggerDoc in the req object.

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocument = require('./swagger.json');
    
    app.use('/api-docs', function(req, res, next){
        swaggerDocument.host = req.get('host');
        req.swaggerDoc = swaggerDocument;
        next();
    }, swaggerUi.serve, swaggerUi.setup());

    Two swagger documents

    To run 2 swagger ui instances with different swagger documents, use the serveFiles function instead of the serve function. The serveFiles function has the same signature as the setup function.

    const express = require('express');
    const app = express();
    const swaggerUi = require('swagger-ui-express');
    const swaggerDocumentOne = require('./swagger-one.json');
    const swaggerDocumentTwo = require('./swagger-one.json');
    
    var options = {}
    
    app.use('/api-docs-one', swaggerUi.serveFiles(swaggerDocumentOne, options), swaggerUi.setup(swaggerDocumentOne));
    
    app.use('/api-docs-two', swaggerUi.serveFiles(swaggerDocumentTwo, options), swaggerUi.setup(swaggerDocumentTwo));

    Requirements

    • Node v0.10.32 or above
    • Express 4 or above

    Testing

    • Install phantom
    • npm install
    • npm test

    Install

    npm i swagger-ui-express

    DownloadsWeekly Downloads

    579,074

    Version

    4.1.6

    License

    MIT

    Unpacked Size

    19.1 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar