handymanServices & Tools
extensionCommon Features
extensionSemantic and Calendar Versioning
Established conventions like SemVer (MAJOR.MINOR.PATCH) and CalVer (YYYY.MM) give API and library producers a shared vocabulary for communicating compatibility and release cadence to consumers.
extensionBreaking Change Detection
Spec-diff tools like oasdiff, openapi-diff, Optic, and GraphQL Inspector compare two versions of an API specification and classify changes as breaking, non-breaking, or unclassified before they ship to production.
extensionSchema Registries and Evolution
Platforms like Apicurio, Confluent Schema Registry, Buf Schema Registry, and Apollo GraphOS track every version of a schema, enforce compatibility rules (backward, forward, full), and prevent incompatible deploys.
extensionAPI Version Headers and Date-Based Versioning
Providers like Stripe and GitHub pin requests to a version via a header or date string, allowing the platform to ship new API behavior without breaking existing integrations.
extensionDeprecation and Sunsetting
The Deprecation and Sunset HTTP headers (RFC 8594 / RFC 9745) and platform-level deprecation policies give consumers structured advance notice that an endpoint or version is going away.
extensionDocumentation and Changelog Versioning
Tools like Bump.sh, Stoplight, Scalar, LaunchNotes, and Keep a Changelog publish per-version API references and human-readable release notes alongside the underlying spec or code change.
extensionConventional Commits and Release Automation
The Conventional Commits specification encodes change type (feat, fix, BREAKING CHANGE) directly in commit messages so that SemVer bumps and changelogs can be generated automatically.
extensionDependency Version Management
Bots like Dependabot and Renovate continuously open pull requests to upgrade dependencies, respecting SemVer ranges and surfacing breaking changes upstream.
task_altUse Cases
task_altPre-Merge Breaking Change Gate
Run oasdiff or Optic in CI on every pull request that touches the OpenAPI spec and block the merge if breaking changes are introduced without an explicit major version bump.
task_altDate-Pinned API Versions
Issue per-account or per-request API versions (e.g. Stripe's 2024-04-10 versioning) so customer integrations remain stable while the platform iterates rapidly behind the scenes.
task_altSchema Registry Compatibility Enforcement
Producers and consumers of Kafka, gRPC, or GraphQL schemas register every revision in Apicurio, Confluent, Buf, or Apollo and the registry refuses incompatible changes at publish time.
task_altMulti-Version API Documentation
Publish v1, v2, and v3 documentation simultaneously through Bump.sh, Stoplight, or Scalar so consumers on older versions still have authoritative reference material.
task_altDeprecation and Sunset Notification
Emit Deprecation and Sunset HTTP headers from deprecated endpoints, then track consumer migration through analytics before fully removing the version.
task_altAutomated SemVer Release
Use Conventional Commits plus tools like semantic-release to compute the next SemVer version, generate a changelog, tag the repo, and publish a release entirely from commit history.
task_altContinuous Dependency Upgrades
Configure Dependabot or Renovate to open weekly PRs for dependency upgrades, with SemVer-aware grouping and automatic merge for non-breaking patches.
task_altAPI Changelog and Release Notes
Publish a structured changelog through LaunchNotes, Beamer, or Keep a Changelog conventions so consumers can review what changed in every API release.
integration_instructionsIntegrations
integration_instructionsOasdiff
Open-source CLI and library that compares two OpenAPI specifications and classifies every change as breaking or non-breaking, with rule-level configuration.
integration_instructionsOptic
API change-management platform that captures real traffic, generates OpenAPI, and gates pull requests on breaking changes against the existing spec.
integration_instructionsBump.sh
API documentation and changelog platform that publishes per-version OpenAPI and AsyncAPI references and surfaces diffs between releases.
integration_instructionsBuf
Buf Schema Registry and CLI for Protocol Buffers, with first-class breaking-change detection and lint rules across proto versions.
integration_instructionsApollo GraphQL
Apollo GraphOS schema registry and Apollo Studio check every proposed GraphQL schema change against operations from real clients before publication.
integration_instructionsApicurio
Open-source schema registry from Red Hat for Avro, JSON Schema, OpenAPI, AsyncAPI, and Protobuf, with pluggable compatibility rules.
integration_instructionsStripe
Stripe's date-based API versioning model pins every integration to a release date and provides a Versioning Stripe API reference for upgrading between versions.
integration_instructionsDependabot
GitHub-native dependency-update automation that opens PRs for upgrades, respecting SemVer ranges and security advisories.
integration_instructionsRenovate
Configurable dependency upgrade bot with SemVer-aware grouping, scheduling, and automerge across npm, Maven, Docker, and many other ecosystems.
integration_instructionsSunset Header
Standard HTTP response header (RFC 8594) for communicating the date at which a resource will become unavailable, used together with Deprecation (RFC 9745).
articleLatest API Stories
Most recent 25 stories pulled from across the API Evangelist network blog feeds.