Как указать версию API?

Question

Согласно справочнику REST API Azure DevOps Services, URI запроса имеет следующий формат:

https://{instance}[/{team-project}]/_apis[/{area}]/{resource}?api-version={version}

Учитывая api-version:

Каждый запрос API должен включать api-версию, чтобы избежать перерыва в работе приложения или службы по мере развития API.

Я начал использовать клиентские библиотеки.NET для служб Azure DevOps (и TFS) для программного управления инструментальными панелями.

Я могу подключиться к DevOps Azure с помощью токена личного доступа:

var credential = new VssBasicCredential(string.Empty, "PersonalAccessToken");

using (VssConnection connection = new VssConnection(new Uri("...."), credential))
using (var client = connection.GetClient<DashboardHttpClient>())
{
     // ...
}

Как я могу указать версию API? Имеет ли смысл делать это при использовании клиентских библиотек.NET?

Answer 1

Версия API определяется клиентскими библиотеками. Вы можете подтвердить это, разобрав их (например, используя ILSpy).

Например, в текущей стабильной версии Microsoft.TeamFoundationServer.Client, DashboardHttpClientBase имеет CreateDashboardAsnc метод, который делает следующий вызов:

this.SendAsync<Dashboard>(..., new ApiResourceVersion("4.1-preview.2"), ...);