npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

api-response-diff

v0.1.0

Published

Compare JSON API response bodies; classify breaking vs non-breaking changes for contract tests, CI gates, and semver-style checks

Readme

api-response-diff

Compare two JSON API response bodies and split changes into breaking vs non-breaking—handy for contract tests, release checks, and OpenAPI-adjacent guardrails. Uses json-diff-core under the hood.

const { compareApiResponses } = require('api-response-diff');

const result = compareApiResponses(
  { data: { id: 1, email: '[email protected]' } },
  { data: { id: 1 } }
);

console.log(result.summary); // e.g. "1 breaking, 0 non-breaking"
console.log(result.hasBreakingChanges); // true
console.log(result.breaking[0].path); // "data.email"

Install

npm install api-response-diff

Default rules (severity)

Breaking (typical):

  • Removed fields or array elements
  • Type narrowing (e.g. string → number where it breaks consumers)
  • Shorter arrays when items disappear

Non-breaking (typical):

  • New optional fields
  • Same-type value updates
  • Widening (e.g. null → concrete value)

Exact heuristics live in the classifier; override per path when your API contract differs.

API

compareApiResponses(before, after, options?)

Returns ApiResponseDiffResult:

| Field | Description | | --- | --- | | breaking / nonBreaking / unknown | Classified changes | | all | Full list with severity and reason | | hasBreakingChanges | Quick gate for CI | | summary | Short counts string |

Options

compareApiResponses(v1, v2, {
  ignorePaths: ['meta.generatedAt'],
  breakingPaths: ['data.status'], // force value edits here to count as breaking
  nonBreakingPaths: ['data.banner'],
});

CI gate example

const { hasBreakingChanges, summary } = compareApiResponses(snapshot, live);
if (hasBreakingChanges) {
  process.exitCode = 1;
  console.error('API breaking changes:', summary);
}

Related packages

  • json-diff-explainer — plain-English lines for any JSON pair
  • json-diff-core — low-level diffJson when you own classification

Why teams pick this

vs eyeballing JSON: breaking vs non-breaking rules for API contract CI gates.

Search terms: api diff, breaking change, json api, contract testing, semver, response compare, backward compatibility, integration test, typescript, node