๐Ÿ“‹ API Changelog Generator

๐Ÿ“ Version Info

โž• Add Change Entry

๐Ÿ“Š Change List

No changes yet. Add entries or load an example...

โš™๏ธ Output Options

๐Ÿ“„ Generated Result

๐Ÿ“š What can API Changelog Generator do?

API Changelog Generator helps developers auto-generate standardized Changelog documents from API endpoint changes. Supports semantic versioning suggestions, multiple output formats, and change categorization.

Core Features

โ€ข Six change types: Added/Changed/Deprecated/Removed/Fixed/Security

โ€ข Semantic versioning: Auto-suggest version numbers by change type

โ€ข Multiple output formats: Markdown/JSON/HTML

โ€ข Batch import: JSON format bulk change import

โ€ข Keep a Changelog convention: Community standard compliance

How to Use

1. Fill in version number and date

2. Add change entries (select type + description)

3. Or batch import via JSON

4. Select output format and generate

5. Copy or download the Changelog

Use Cases

โ€ข API Releases: Auto-generate change records for each release

โ€ข Team Collaboration: Standardize change record format

โ€ข Documentation: Auto-maintain CHANGELOG.md

โ€ข CI/CD Integration: Export JSON for automation pipelines

Extended Knowledge

Keep a Changelog is a community-maintained convention suggesting Added/Changed/Deprecated/Removed/Fixed/Security categories. Semantic Versioning (SemVer) uses MAJOR.MINOR.PATCH: breaking changes bump MAJOR, new features bump MINOR, fixes bump PATCH. A good Changelog is key to API maintainability.

โ“ FAQ

What is an API changelog?

An API changelog records every change to an API, including new endpoints, modified parameters, removed features. It helps consumers understand changes and assess upgrade impact.

What change types are supported?

Supports Added, Changed, Deprecated, Removed, Fixed, and Security โ€” six standard types following Keep a Changelog convention.

How is version number determined?

Based on SemVer: new features โ†’ MINOR, breaking changes โ†’ MAJOR, fixes โ†’ PATCH. The tool auto-suggests version numbers.

What is the output format?

Default Markdown following Keep a Changelog. Also supports JSON for automation integration.

Can I customize the template?

Yes. Custom title format, date format, category order, and custom change types.

Can I batch import changes?

Yes. Batch import via JSON format, or add individually with type and description.

API Changelog Generator | No Signup, Client-Side ยท No Server Uploads

Feedback: dexshuang@google.com