通过REST API的VSTS扩展文档

基础概念

VSTS (Visual Studio Team Services) 是微软提供的 DevOps 平台（现更名为 Azure DevOps），用于项目管理、代码托管、持续集成/交付（CI/CD）等。REST API 是其提供的标准化接口，允许开发者通过 HTTP 请求与平台交互，实现自动化操作（如创建任务、拉取代码、触发构建等）。VSTS 扩展 则是通过自定义插件或工具扩展平台功能的模块。

类型与功能

核心 API：
- 项目管理：创建/更新工作项（_apis/wit/workitems）。
- 版本控制：操作 Git 仓库（_apis/git/repositories）。
- 流水线：触发构建或发布（_apis/build/builds）。

扩展 API：
- 自定义界面：通过贡献点（Contribution Points）扩展 UI。
- 服务钩子：监听事件（如代码推送）并触发外部服务。

应用场景

自动化部署：通过 API 触发流水线，部署到云服务器。
数据同步：将工作项同步到外部 CRM 或数据库。
监控告警：监听构建失败事件并发送通知到 Slack。
自定义工具：开发团队专用的代码审查插件。

常见问题与解决

问题1：认证失败

原因：未正确配置 PAT 或 OAuth 令牌。
解决：
解决：
确保 PAT 具有所需权限（如 WorkItems.ReadWrite）。

问题2：API 响应慢

原因：查询数据量过大或网络延迟。
解决：
- 使用 $top 和 $skip 分页：
- 使用 $top 和 $skip 分页：
- 启用压缩头：Accept-Encoding: gzip。

问题3：扩展未生效

原因：未正确注册贡献点或清单文件（vss-extension.json）错误。
解决：
解决：

示例代码（Python）

import requests

# 获取项目列表
url = "https://dev.azure.com/{org}/_apis/projects"
headers = {"Authorization": f"Bearer {PAT}"}
response = requests.get(url, headers=headers)
print(response.json())

# 创建工作项
payload = [{
    "op": "add",
    "path": "/fields/System.Title",
    "value": "Fix API bug"
}]
response = requests.patch(
    "https://dev.azure.com/{org}/{project}/_apis/wit/workitems/$Task?api-version=6.0",
    json=payload,
    headers={"Content-Type": "application/json-patch+json", **headers}
)