New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

openapi-diff

Package Overview
Dependencies
Maintainers
2
Versions
36
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

openapi-diff

A CLI tool to identify differences between Swagger/OpenAPI specs.

  • 0.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
39K
decreased by-2.14%
Maintainers
2
Weekly downloads
 
Created
Source

OpenAPI Diff

A CLI tool to identify differences between Swagger/OpenAPI specs.

Requirements

  • NodeJS 4.x or higher (tested using 4.x, 6.x and 8.x)
  • NPM 2.x or higher (tested using 2.x, 3.x and 5x)

Installation

Install the tool using NPM:

npm install --global openapi-diff

Usage

Invoke the tool with two paths to Swagger/OpenAPI files in order to find differences between them. These files should be in JSON format.

openapi-diff /path/to/old/openapi.json /path/to/new/openapi.json 

The tool's output will display amount and type of changes (breaking, non-breaking, unclassified), and then list the changes with the relevant info.

Feature support

Supported

  • Editions to the Info object and ^x- properties at the top level of the spec.

Beta support

  • Additions and deletions to the Info object and ^x- properties at the top level of the spec.

Not supported

  • Any other additions, editions or deletions to the spec.
  • Specs in YML format
  • Specs as URLs

Keywords

FAQs

Package last updated on 07 Jul 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc