Posts Tagged: API Versioning

How to Smartly Sunset and Deprecate APIs

The life of an API follows a predictable lifecycle – from creation to deprecation, each stage of the API lifecycle denotes an important event, and it carries with it a set of best practices. API developers tend to think about the future in very positive ways – how the API will behave, what its design will be – but in doing so, they don’t always consider what the end of that API might look like. Read more

Methods To Communicate API Change Effectively

The API industry thrives on change. As the needs of the consumer grows, so too do the demands on the API provider. Accordingly, providers are faced with the growing prospect of constant technological evolution.

While this cycle of change is largely a positive one, it does bring with it some unique challenges; one such challenge is that of communicating change to your developer users. Read more

API Change Strategy

Some people, when confronted with a problem, think “I know, I’ll use versioning.” Now they have 2.1.0 problems.

Brandon Byers

Software Versioning

If your software has a fuzzy or seemingly random versioning scheme — or no apparent version number at all — you’ll likely agree it can be a nightmare to work with. Read more

Using Canary Release To Ease API Versioning

One of the greatest struggles an API provider can face is how to manage versions and builds from instance to instance. The constant need to iterate matched with the constant need to organize has made versioning a controversial and often discussed facet of modern API development. Read more

Introduction to API Versioning Best Practices

Change is inevitable and growth is a good thing. When your API has reached the point of expanding beyond it’s original intent and capacity, it’s time to consider the next version.

Whether that next iteration is a whole number version bump or just a feature expansion, it’s important to consider the pros and cons of how you let your developers know about it. Read more