Swagger Express Middleware

Swagger middlware and mocks for Express.js and Node

Swagger Express Middleware

Swagger middleware and mocks for Express.js

Build Status Dependencies Coverage Status Tested on APIs.guru Codacy Score Inline docs

npm License


Installation and Use

Install using NPM.

npm install swagger-express-middleware

Then use it in your Node.js script like this:

const express = require('express');
const createMiddleware = require('swagger-express-middleware');

let app = express();

createMiddleware('PetStore.yaml', app, function(err, middleware) {
    // Add all the Swagger Express Middleware, or just the ones you need.
    // NOTE: Some of these accept optional options (omitted here for brevity)

    app.listen(8000, function() {
        console.log('The PetStore sample is now running at http://localhost:8000');

Samples & Walkthroughs

Swagger Express Middleware comes two samples that use the Swagger Pet Store API.

Sample 1

This sample demonstrates the most simplistic usage of Swagger Express Middleware. It simply creates a new Express Application and adds all of the Swagger middleware without changing any options, and without adding any custom middleware.

Sample 2

This sample demonstrates a few more advanced features of Swagger Express Middleware, such as setting a few options, initializing the mock data store, and adding custom middleware logic.


I welcome any contributions, enhancements, and bug-fixes. File an issue on GitHub and submit a pull request.


To build/test the project locally on your computer:

  1. Clone this repo
    git clone https://github.com/APIDevTools/swagger-express-middleware.git

  2. Install dependencies
    npm install

  3. Run the tests
    npm test

  4. Run the sample app
    npm start


Swagger Express Middleware is 100% free and open-source, under the MIT license. Use it however you want.