Controle de versão da API REST

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Usando APIs REST com versão, você pode garantir que seus projetos sejam escalonáveis e mantêveis ao longo do tempo e que seus aplicativos e serviços continuem 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 está 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.0por 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. Após uma API em versão prévia ter sido desativada, as solicitações que especificam uma versão -preview passam a ser 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

Parâmetro de consulta 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

O Team Foundation Server foi renomeado para Servidor do Azure DevOps em 2019.

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.

Conteúdo relacionado

• Introdução às APIs REST
• Referência da API REST do Azure DevOps Services