Versioning, API versions and breaking changes

Developing reliably on top of an evolving platform

Even in a demo it is useful to show how to handle API versioning. Leafy Energy therefore introduces a simple but recognisable versioning concept.

API versions

• Versioning in the URL, for example /v1/... and /v2/....
• SDKs that default to the latest stable version.
• Option to explicitly select a version per client instance.

Breaking changes (concept)

• Major changes are announced with a deprecation window.
• The sandbox receives breaking changes first so teams can test.
• SDKs log warnings when you call deprecated endpoints.

This article helps you explain to architects that a Leafy Energy style platform takes lifecycle and stability seriously, even in demo form.