Azure DevOps构建管道语法错误：REST API发布Wiki遇阻

一、确认构建管道发布Wiki的合理性 #

通过构建管道自动化发布Azure DevOps Wiki是完全可行且合理的方案，适用于以下场景：

• 将代码仓库中维护的Markdown文档同步到Wiki，实现文档的版本化管理
• 持续集成过程中自动更新Wiki内容，比如发布新版本时同步更新文档
• 统一文档发布流程，减少手动操作的误差

Azure DevOps提供了REST API用于操作Wiki，构建管道可以借助这些API完成自动化发布，是官方支持的实现方式。

二、解决PowerShell脚本中$body变量的语法错误 #

在AzurePowerShell@5任务中，构造API请求体时的语法错误多来自JSON字符串转义或变量拼接问题，以下是两种可靠的实现方式：

方式1：使用Here-String构造JSON请求体 #

Here-String允许直接编写原生JSON结构，无需转义双引号，适合结构固定的场景：

# 从管道变量获取组织、项目信息
$orgUri = "$(System.TeamFoundationCollectionUri)"
$projectName = "$(System.TeamProject)"
$targetWikiName = "项目文档Wiki"
$sourceRepoName = "wiki"
$repoId = "$(wikiRepositoryId)" # 可提前通过API查询或设置为管道变量

# 构造请求体
$body = @"
{
    "name": "$targetWikiName",
    "type": "codeWiki",
    "repository": {
        "id": "$repoId",
        "name": "$sourceRepoName",
        "type": "git"
    },
    "mappedPath": "/"
}
"@

# 调用API创建/更新Wiki
$apiEndpoint = "$orgUri/$projectName/_apis/wiki/wikis?api-version=7.1-preview.2"
Invoke-RestMethod -Uri $apiEndpoint `
                  -Method Post `
                  -Headers @{ Authorization = "Bearer $(System.AccessToken)" } `
                  -Body $body `
                  -ContentType "application/json"

方式2：通过PowerShell对象转换为JSON #

这种方式更灵活，适合动态生成请求体的场景，PowerShell会自动处理转义：

# 定义请求体对象
$bodyObject = @{
    name = "项目文档Wiki"
    type = "codeWiki"
    repository = @{
        id = "$(wikiRepositoryId)"
        name = "wiki"
        type = "git"
    }
    mappedPath = "/"
}

# 转换为JSON（-Depth参数确保嵌套结构被正确序列化）
$body = $bodyObject | ConvertTo-Json -Depth 10

# 后续API调用同方式1

关键注意事项 #

• 确保构建任务已勾选Allow scripts to access OAuth token，这样$(System.AccessToken)才能拥有操作Wiki和仓库的权限
• 如果不知道仓库ID，可以先调用以下API查询：

  $repoListUrl = "$orgUri/$projectName/_apis/git/repositories?api-version=7.1-preview.1"
  $repos = Invoke-RestMethod -Uri $repoListUrl -Headers @{ Authorization = "Bearer $(System.AccessToken)" }
  $targetRepo = $repos.value | Where-Object { $_.name -eq "wiki" }
  $repoId = $targetRepo.id
  

• API版本建议使用最新的预览版或正式版，确保兼容性

内容的提问来源于stack exchange，提问作者Al Jubaiar