API Changelog Generator
Generate a Markdown changelog from two OpenAPI versions.
Previous spec
Current spec
Generated changelog
Markdown ready to paste into CHANGELOG.md or release notes
# Orders API changelog
## 2.0.0 — 2026-09-29
_Compared against 1.2.0. 3 breaking, 0 risky, 1 additive changes._
> **Heads up:** this release contains breaking changes. Bump the major version and notify integrators before deploying.
### Breaking changes
- **GET /orders** — New required query parameter `status` — existing callers will fail.
- **GET /orders** — Response `200 application/json` schema changed.
- **GET /orders/{orderId}** — Response `404` removed.
### Added
- **POST /refunds** — New operation added.
### Migration guide
1. `GET /orders` — New required query parameter `status` — existing callers will fail.
2. `GET /orders` — Response `200 application/json` schema changed.
3. `GET /orders/{orderId}` — Response `404` removed.
About the API Changelog Generator
Diff two OpenAPI documents and produce a release-ready Markdown changelog grouped into Breaking Changes, Added, Changed and Removed, complete with a suggested semantic version bump you can paste straight into release notes or docs.
Examples
v1 → v2
Two OpenAPI documentsOutput
SQL## Breaking Changes
- Removed `DELETE /users/{id}`Keyboard shortcuts
- Copy the main outputCtrl / ⌘ + Shift + C
- Download the resultCtrl / ⌘ + S
- Share this toolCtrl / ⌘ + Shift + S
- Reset the inputsAlt + R
- Open the tool search paletteCtrl / ⌘ + K
Related tools
API Breaking Change Detector
API & HTTP
Diff two OpenAPI specs and flag breaking changes.
API Consistency Auditor
API & HTTP
Audit an API for naming, casing and response consistency.
API Contract Analyzer
API & HTTP
Lint an OpenAPI or Swagger spec for contract quality issues.
Postman ↔ OpenAPI Converter
API & HTTP
Convert a Postman collection to OpenAPI 3 and back again.
API Response Schema Generator
API & HTTP
Turn a JSON API response into OpenAPI, JSON Schema or TypeScript.
cURL Command Parser
API & HTTP
Parse a curl command into method, URL, headers, and body.
Frequently asked questions
Read more
- Postman collections and OpenAPI: two views of the same API
A collection describes calls you make; a spec describes the contract you promise. Here is how to convert between them without losing the parts that matter.
Version 1.0.0 · Updated 2026-08-20 · Runs entirely in your browser