swagger-mod

Modifies an existing swagger document using filters. Many examples can be found in examples directory in the source code repository.

How to use the library

Install the library.

npm install swagger-mod --save

Use the Promises syntax to modify your swagger document.

The code snippet below filters an existing swagger document by HTTP methods. The resultant swagger will only contain GET, PUT and DELETE methods. To exclude an HTTP method simply use the exclude tag inside http tag. Note that you cannot use include and exclude both at once.

const swaggerMod= require("swagger-mod");

const opts = {
    filters: {

        // Filter by HTTP methods
        // Do not use regular expressions here
        http: {
            include: ['get', 'put', 'post']
        }
    }
};

swaggerMod('https://petstore.swagger.io/v2/swagger.json', opts)
  .then(function(modifiedSchema) {
    console.log(modifiedSchema); 
  }).catch(function(err) {
    console.error(err);
  });

Given below is an example for filtering by tags. Use regular expressions to do the filtering.

const swaggerMod= require("swagger-mod");

const opts = {
    filters: {

        // Filter by tags using regular expressions
        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
        tags: {
            exclude: [
                '/^pet$/i', // Exact match( case insensitive)
                '/store/i' // Ignores case
            ]
        }
    }
};

swaggerMod('https://petstore.swagger.io/v2/swagger.json', opts)
  .then(function(modifiedSchema) {
    console.log(modifiedSchema);     
  }).catch(function(err) {
    console.error(err);
  });

You can chain your filters like this.

const opts = {
    filters: {

        // Filter by HTTP methods
        http: {
            include: ['get', 'delete']
        },

        // Filter by paths using regular expressions
        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
        paths: {
             exclude: [
                '//pet/findByStatus/'
             ]
        }
    }
};

Available filters

• http
• paths
• tags
• summary
• description

Other examples

The examples directory in the source code repository has many examples.

A demo application

A demo express app using swagger-mod can be found here.

Writing regular expressions

A regular expression is is a pattern enclosed within two slashes.

/Store/

^ matches the beginning of input and $ matches end of input. Therefore the regular expression below matches Store.

/^Store$/

To make this case insensitive add i flag. The regular expression below matches Store, store, STORE etc.

/^Store$/i

For more ways to write regular expressions refer to the documentation.

License

The Project is under MIT License. Internet is free. Use the code anyway you like.

Sample swagger document swagger.json is under Apache 2.0 License.