如何指定API版本？

Question

根据Azure DevOps服务REST引用，请求URI具有以下格式：

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

关于api-version

每个API请求都应该包含一个api版本，以避免随着api的发展而中断应用程序或服务。

我开始使用用于Azure DevOps服务(和TFS)的DevOps客户端库以编程方式管理仪表板。

我可以使用个人访问令牌连接到Azure DevOps：

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"), ...);