Controle de versão de API REST

  • Artigo

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Usando APIs REST com controle de versão, você pode garantir que seus projetos sejam escalonáveis e mantêveis ao longo do tempo, enquanto aplicativos e serviços continuam funcionando à medida que as APIs evoluem.

Diretrizes

  • A versão da API deve ser especificada a cada solicitação.
  • As versões da API estão no formato {major}. {minor} [-{stage}[.{ resource-version}]] - Por exemplo, 1.0, 1.1, 1.2-preview, 2.0.
  • Enquanto uma API estiver em versão prévia, você pode especificar uma versão precisa de uma revisão específica da API quando necessário (por exemplo, 1.0-preview.1, 1.0-preview.2).
  • Depois que uma API é lançada (1.0, por exemplo), sua versão prévia (1.0-preview) é preterida e pode ser desativada após 12 semanas.
  • Durante esse tempo, você deve atualizar para a versão lançada da API. Depois que uma API de visualização é desativada, as solicitações que especificam uma -preview versão são rejeitadas.

Uso

A versão da API pode ser especificada no cabeçalho da solicitação HTTP ou como um parâmetro de consulta de URL:

Cabeçalho de solicitação HTTP:

Accept: application/json;api-version=1.0

Uri:

[scheme"://"][host[':'port]]"/v" major-version '/'namespace '/'resource ('/'resource)* '?' query

i.e. GET https://dev.azure.com/v1.0/{organization}/_apis/{area}/{resource}?some-query=1000

Versões com suporte

Produto 1.0 2,0 3.0 4,0 5,0 6,0 7.0
Azure DevOps Services X X X X X X X
Azure DevOps Server 2022 X X X X X X X
Azure DevOps Server 2020 X X X X X X -
Azure DevOps Server 2019 X X X X X -
Team Foundation Server 2018 X X X X - -
Team Foundation Server 2017 X X X - - -
Team Foundation Server 2015 X X - - - -

As versões principais da API se alinham às versões RTM do Team Foundation Server. Por exemplo, o 3.0 conjunto de API foi introduzido com o Team Foundation Server 2017.

Algumas APIs não documentadas da versão 1.0 existiam no Team Foundation Server 2013, mas não têm suporte.