+ Blog

Bite-sized blog posts on building your best API

How to version your API

February 26, 2020

This is part of a multi-part series on how to version your API.

We are wrapping up our multi part series on versioning with a summary of our recommendations. Feel free to look through the previous blog posts for a more in-depth discussion.

versioning

Where should I put my API version?

February 24, 2020

This is part of a multi-part series on how to version your API.

After having discussed how to represent your version, the final question is naturally then where to represent that version.

versioning

Should I use semantic versioning for my API?

February 22, 2020

This is part of a multi-part series on how to version your API.

We've heard a lot of questions about whether to consider Semantic Versioning for your API. Below we talk through what is Semantic Versioning and whether it works for your API.

versioning

Should I use a date to version my API?

February 20, 2020

This is part of a multi-part series on how to version your API.

In our last post we talked about using an integer to version your API. Today we are going to talk about a date.

versioning

Should I use an integer to version my API?

February 18, 2020

This is part of a multi-part series on how to version your API.

We are talking through the various ways you can version your API and today are considering using integers.

versioning

What is a breaking API change?

February 16, 2020

This is part of a multi-part series on how to version your API.

As previously discussed, the whole point of versioning is to manage change so you can evolve your API without breaking your client's implementation. In order to do this, changes that will "break" will your client's implementation warrant a new version. But what is and is not "breaking" can be tricky.

versioning

Why should I version my API?

February 14, 2020

This is part of a multi-part series on how to version your API.

We often hear a lot of questions and confusion around versioning your API so we are starting a whole blog series on versioning.

We'll start by answering the basic question of, "Why should I even version my API in the first place?"

versioning