π Version Info
β Add Change Entry
π Change List
βοΈ 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 of API Changelog Generator
β’ 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
API Changelog Generator in 3 steps
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
When to use API Changelog Generator
β’ 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.