Controle de versão da API REST

Serviços de DevOps do Azure | Azure DevOps Server 2022 - Azure DevOps Server 2019

Usando APIs REST versionadas, você pode garantir que seus projetos sejam escaláveis e fáceis de manter ao longo do tempo, enquanto os aplicativos e serviços continuam a funcionar à medida que as APIs evoluem.

Orientações

• A versão da API deve ser especificada em 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 visualização, 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).
• Quando uma API é lançada (1.0, por exemplo), sua versão de visualização (1.0-preview) é preterida e pode ser desativada após 12 semanas.
• Durante esse período, 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 versão -preview são rejeitadas.

Utilização

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 da 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 suportadas

As principais versões da API estão alinhadas com as versões RTM do Team Foundation Server. Por exemplo, o conjunto de API 3.0 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 são suportadas.

Artigos relacionados

• Introdução às APIs REST
• Referência da API REST dos Serviços de DevOps do Azure