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 🙏

© 2024 – Pkg Stats / Ryan Hefner

openapi-diff-node

v2.1.1

Published

An openapi diffing tool for node.js

Downloads

13

Readme

openapi-diff-node

A tool for diffing two openapi-compatible api schema.

Goal

  • To quickly and easily find out the differences between the two openapi schemas.
  • To filter out unnecessary information from overly complicated schema.

No-Goal

  • Display an exhaustive list of all details of every endpoint in openapi schema.

Usage

  • We assume all request and response bodies are in application/json format.
  • Error responses are not supported. For response bodies, a response of status code 200 will be used first, then 201. If no responses are of status code 200 or 201, response object will simply be an empty object.

import { openapiDiff } from 'opeanpi-diff-node';

const diff: DiffOutputItem = openapiDiff(oldOpenapiSchema, newOpenapiSchema);

console.log(diff);
  • see following interfaces for the type of the result
export interface DiffOutputItem {
  path: string; // path of the endpoint
  method: ApiHttpMethod; // http method of the endpoint
  description: string; // description of the endpoint (added in v2.0.0), summary is used if description is not provided.
  queryParams: QueryParam[]; // changes in query string parameters
  requestBody: RequestBody[]; // changes in http request body (application/json)
  responseBody: ResponseBody[]; // changes in http response body (application/json)
  status: ApiStatus;
}

interface QueryParam extends CommonEndpointInfo {}
interface RequestBody extends ObjectSchemaBase {}
interface ResponseBody extends ObjectSchemaBase {}

interface ObjectSchemaBase extends CommonEndpointInfo {}

interface CommonEndpointInfo extends FlattenedCommonEndpointInfo, DiffInfo {}

interface DiffInfo {
  status: ApiStatus;
  modifiedFields: string[];
}

type ApiStatus = 'REMOVED' | 'MODIFIED' | 'ADDED' | 'UNCHANGED';

export interface FlattenedCommonEndpointInfo {
  name: string;
  description: string;
  required: boolean;
  type: string;
}

Starting Development Server

  • make a directory of src/__local__/examples and place two files. This directory is git-ignored.
    • openapi-old.json : an old openapi schema file.
    • openapi-new.json : a new openapi schema file.
npm install
npm run dev
  • Hot reload is fully supported. See console for the result of the diff.

Building for Production

npm run build

Checking Types

npm run check:types

(tsc will be added as a DevDependency in the future)