smile

The Problem

Keeping an API’s documentation synchronized with its actual behavior in production is a constant challenge. Teams commonly write specifications (OpenAPI, AsyncAPI, etc.) that quickly drift from reality, leading to integration bugs and a false sense of security. Validating that an API strictly complies with its established contract usually requires heavy configurations, complex dependencies, or is simply skipped entirely in CI/CD pipelines.

The Solution

smile was built as a strict, zero-dependency contract validator designed to integrate natively into testing suites (Vitest/Jest) and CI workflows. It acts on two fronts:

1. Static Linter: Rapidly analyzes specification files to ensure they meet completeness standards and best practices, intentionally failing CI builds if violations are found.
2. Breaching Detector (Runtime Validation): By pointing smile at a live server environment, it fires real HTTP requests against documented endpoints, validating that response payloads strictly match the established contract schemas.

Featuring a built-in rule engine and incremental configuration, smile acts as a relentless judge that isolates and highlights any deviations, guaranteeing that the backend always tells the truth.

---

To view the complete documentation for installation, validation rules, and supported formats, you can visit the official repository on GitHub.