Tag Archives: version

How to design APIs that last

[Caveat: this is focused on HTTP-based, or REST APIs]

In the software world, we often refer to building ‘extensible’ designs. In essence, this means that we can build a system that is light and nimble, capable of changing and growing over time.

In the world of API design, we can’t always make rapid changes. Many API clients become dependent on existing functionality.

Think about this from the perspective of sustainability:
How long can we keep and grow this design?
How long before we have to start over on another version?

old_reliable_api
Continue reading “How to design APIs that last” »

Do you really need API Versioning?

The only thing that we know for certain about the future is that things will change, and that is especially true in our industry. If your APIs are successful they will be used in ways you never had foreseen and the data you deliver will be combined with other data in very surprising ways.

photo by Bruce Denis

At the same time technology will change and what your organisation can and want to deliver to its customers will change. In order to keep relevant and to keep serving these ever evolving needs and requirements your APIs need to change and you need to know how to handle these changes.

Continue reading “Do you really need API Versioning?” »