如何在Azure DevOps项目中通过REST API搜索代码时添加仓库筛选器？附当前实现代码及问题

你遇到的问题核心是筛选器的JSON结构不符合API的要求。Azure DevOps的Code Search API对filters字段的格式有明确规定，不是简单的键值对，而是需要用包含name和values的对象数组来定义筛选规则。

你的代码问题点 #

你当前直接把Repository作为键、仓库名数组作为值传入filters，但API期望的是：filters是一个数组，数组里的每个元素是一个完整的筛选器对象，必须包含name（筛选类型）和values（筛选值数组）两个属性。

修正后的完整代码实现 #

下面是调整后的代码，我标注了关键修改部分：

string[] targetRepos = new string[] { "MyRepo" };
string[] targetBranches = new string[] { "master" };

// 构造仓库筛选器对象：明确指定name和values
JObject repoFilter = new JObject(
    new JProperty("name", "Repository"),
    new JProperty("values", JArray.FromObject(targetRepos))
);

// 可选：构造分支筛选器对象（如果需要同时筛选分支）
JObject branchFilter = new JObject(
    new JProperty("name", "Branch"),
    new JProperty("values", JArray.FromObject(targetBranches))
);

// 构造符合API要求的请求Payload
JObject payLoad = new JObject(
    new JProperty("searchText", item),
    new JProperty("$top", 133),
    // 将筛选器放入数组中，支持同时添加多个筛选规则
    new JProperty("filters", new JArray(repoFilter, branchFilter)) 
    // 如果只需要仓库筛选，改为new JArray(repoFilter)即可
);

var newcontent = new StringContent(payLoad.ToString(), Encoding.UTF8, "application/json");
using (HttpResponseMessage response = client.PostAsync("https://almsearch.dev.azure.com/myorganization/_apis/search/codesearchresults?api-version=5.1-preview.1", newcontent).Result)
{
    // 这里添加响应处理逻辑，比如读取响应内容、判断状态码等
}

关键规则说明 #

• filters必须是JSON数组，每个数组元素是一个筛选器对象
• 每个筛选器对象必填两个属性：
  • name：指定筛选类型，支持Repository、Branch、Project、Path等
  • values：对应筛选类型的取值数组，支持传入多个值实现多条件筛选
• 可以同时添加多个筛选器（比如同时筛选仓库和分支），API会自动处理多条件的逻辑与

按照这个结构构造请求，就能让API正确识别仓库筛选规则了。

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