Skip to content

OpenAPI Changelog Generator

Diff two OpenAPI JSON specs and list added, removed and changed endpoints by method and path as a Markdown changelog.

OpenAPI Changelog Generator

Output

Working…

Updated . Provided as is. Check the output before you rely on it in production.

How to use OpenAPI Changelog Generator

  1. 1

    Paste the old spec

    Paste the previous OpenAPI document as JSON.

  2. 2

    Paste the new spec

    Paste the updated OpenAPI document as JSON.

  3. 3

    Generate the changelog

    Endpoints are compared by path and method and grouped into added, removed and changed.

  4. 4

    Copy the result

    Copy the changelog into release notes or a pull request description.

Questions and answers

Does it support YAML specs?
Not yet. Convert YAML to JSON first, for example with the YAML to JSON Converter.
What counts as a breaking change?
Removed endpoints always break clients. Changed endpoints need a closer look at their parameters and responses.

Use it as an API

OpenAPI Changelog Generator is also callable as a free HTTP JSON API at https://aidevhub.io/api/openapi-changelog/ — GET with query parameters or POST with a JSON body, no authentication, CORS enabled, fair use (abusive traffic is throttled at the edge; there is no per-request quota header). Responses return { ok, tool, result, meta }. 

curl -s -X POST https://aidevhub.io/api/openapi-changelog/ \
  -H "Content-Type: application/json" \
  -d '{"old_spec":"{\"openapi\":\"3.0.0\",\"paths\":{\"/users\":{\"get\":{\"summary\":\"list\"}}}}","new_spec":"{\"openapi\":\"3.0.0\",\"paths\":{\"/users\":{\"get\":{\"summary\":\"list\"}},\"/orders\":{\"get\":{\"summary\":\"list orders\"}}}}"}'

Machine-readable contract: /api/tool/openapi-changelog.json All API endpoints: /agents/ LLM site index: /llms.txt

For AI agents: how to call this tool

Machine-readable contract, endpoints and examples. Humans can ignore this section.

Best Path For Builders

Dedicated API endpoint

Deterministic outputs, machine-safe contracts, and production-ready examples.

Dedicated API

https://aidevhub.io/api/openapi-changelog/

OpenAPI: https://aidevhub.io/api/openapi.yaml

GET /api/openapi-changelog/ GET openapi-changelog
POST /api/openapi-changelog/ POST openapi-changelog

Unified Runtime API

https://aidevhub.io/api/tools/run/?toolId=openapi-changelog&a=%7B%0A%20%20%22openapi%22%3A%20%223.0.0%22%2C%0A%20%20%22paths%22%3A%20%7B%0A%20%20%20%20%22%2Fusers%22%3A%20%7B%0A%20%20%20%20%20%20%22

GET and POST are supported at /api/tools/run/ with identical validation and limits.

Limit: 30 req / 60s, input max 256 KB.