Por quê versionar uma API REST

O primeiro motivo é com relação ao formato de dados. O formato define como os dados serão trocados entre um web server e um cliente.

Seja quando acessamos determinado site ou requisitamos alguma informação de uma API, ela vai trocar os dados conosco.

Esses dados podem ser definidos em alguns formatos, como JSON e XML.

Porém, a ideia é que seja disponibilizado nos dois.

XML

Ideal para um serviço mais legado que permanecerá disponível.

JSON

E disponibilizar também endpoints para serem consultados no formato JSON.

Logo, para termos ambos formatos, precisamos versionar a nossa API REST.

Mas podemos ter outro motivo também! Os dados podem ter uma mudança significativa por um determinado endpoint:

No exemplo acima, o JSON possui a propriedade salary! Podemos considerar o lado esquerdo como uma Versão 0 (padrão) e a do lado direito como uma Versão 1.0.