Skip to content

v1.0.0 - Initial Release

Choose a tag to compare

@77QAlab 77QAlab released this 15 Feb 16:17
· 6 commits to main since this release

schema-sentinel v1.0.0

Know when your APIs change before your users do.

Features

  • Schema inference engine (JSON, XML, GraphQL) with format detection
  • Schema diff engine detecting 10 types of drift with severity levels
  • Multi-format report generator (Console, JSON, Markdown, HTML)
  • File-based snapshot store with versioning
  • CLI tool with 6 commands: snapshot, check, diff, list, history, watch
  • Watch mode with Slack/webhook alerts for monitoring third-party APIs
  • Backward compatibility scoring (0-100%)
  • CI/CD exit codes for pipeline gating

Integration Examples

  • Jest, Mocha, Playwright, Cypress, Supertest (JS/TS - direct import)
  • Karate, REST Assured (Java - CLI bridge)
  • pytest (Python - CLI bridge)
  • Postman/Newman (CLI pipeline)

Install

npm install schema-sentinel

Quick Start

import { SchemaGuard } from 'schema-sentinel';
const guard = new SchemaGuard({ store: './schemas' });
const report = await guard.check('GET /users/:id', responseData);

Stats

  • 101 tests passing
  • 39.8 KB package size
  • Zero-config: no OpenAPI spec required