One of the most important parts of a public API's documentation is the Changelog. During the initial discovery + integration phase, new consumers will spend most of their time reading your docs. After your consumers are integrated it becomes really important to keep them up-to-date on changes to the API.
Stripe has a great changelog that many API companies wish to emulate. It's unfortunately very difficult to keep track of, and manually document, every historical API change.
That's where Optic (the open source API version control tool) can help. Its new history command will use Git history to write a date-based changelog in markdown.
optic history openapi.yml > changelog.md
That's it! Now you have a Stripe-style changelog!
Top comments (0)