DEV Community

Why I don't like "v1" in an API URL

marian-varga on March 21, 2024

I've recently read a quite useful article on API design best practices. But I wasn't quite comfortable with one point in it, the one advocating pu...
Collapse
 
evandroamparo profile image
Evandro da Silva Amparo • Edited

This is a fascinating discussion about versioning. A few months ago, I gave a presentation on the same topic. I completely agree that we should not blindly follow best practices without considering our own specific needs.

However, if we decide to version our APIs, one thing is absolutely crucial: communication. Proper documentation is an excellent way to communicate any breaking changes. Regardless of who our API consumers are, they must be made aware of any upcoming changes in the API contract.