Controle de versão da API REST

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

Ao utilizar APIs REST com controlo de versões, pode garantir que os projetos são dimensionáveis e que podem ser mantidos ao longo do tempo, enquanto as aplicações e os serviços continuam a funcionar à medida que as APIs evoluem.

Diretrizes

• A versão da API deve ser especificada com cada solicitação.
• As versões da API estão no formato {major}. {menor} [-{estágio}[.{ resource-version}]] - Por exemplo, 1.0, , 1.2-preview1.1, 2.0.
• Enquanto uma API está em pré-visualização, pode especificar uma versão precisa de uma revisão específica da API, sempre que necessário (por exemplo, 1.0-preview.1, 1.0-preview.2).
• Depois do lançamento de uma API (por exemplo, 1.0), a versão de pré-visualização (1.0-preview) é preterida e pode ser desativada após 12 semanas.
• Durante este período, deverá atualizar para a versão lançada da API. Assim que uma API de pré-visualização for desativada, os pedidos que especificam uma versão -preview serão rejeitados.

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 foi introduzido com o 3.0 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 do Azure DevOps