synergylabs/BuildingDepot

Version the API

Opened this issue · 1 comments

Versioning the API allows the clients of an API to decide if they are ready to upgrade to a new version. Clients may not always want to upgrade because:

  • They are unsure if the new version actually works
  • The new version works differently, and they don't have time to update their code that uses it

There are two common ways to version an API:

  • Include it in the url
  • Include it in an HTTP Header

See https://www.baeldung.com/rest-versioning