如何在.NET中实现SonarCloud API的认证与调用

第一步：获取SonarCloud访问令牌 #

• 登录SonarCloud账号，进入My Account > Security页面
• 点击Generate Token，输入令牌名称（比如"DotNetApiAccess"），勾选匹配你API调用需求的权限（只读权限通常满足查询类操作）
• 生成后立即复制并妥善保存令牌，页面仅会显示一次，丢失后只能重新生成

第二步：实现认证与API调用的两种方式 #

方式一：使用原生HttpClient手动实现

无需额外依赖，适合轻量场景：

1. 将令牌存入配置文件（如appsettings.json），避免硬编码：

{
  "SonarCloudSettings": {
    "Token": "你的SonarCloud令牌",
    "BaseUrl": "https://sonarcloud.io/api/"
  }
}

2. 在代码中读取配置，创建HttpClient并配置认证头：

using System.Net.Http.Headers;
using Microsoft.Extensions.Configuration;

var config = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

var sonarToken = config["SonarCloudSettings:Token"];
var baseUrl = config["SonarCloudSettings:BaseUrl"];

using var httpClient = new HttpClient { BaseAddress = new Uri(baseUrl) };
// SonarCloud支持Basic认证：用户名填令牌，密码留空即可
var authToken = Convert.ToBase64String(System.Text.Encoding.ASCII.GetBytes($"{sonarToken}:"));
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", authToken);

// 示例：调用获取项目列表的API
var response = await httpClient.GetAsync("projects/search");
response.EnsureSuccessStatusCode(); // 请求失败时抛出异常

var content = await response.Content.ReadAsStringAsync();
// 可将content反序列化为实体类，再写入数据库
Console.WriteLine(content);

方式二：使用官方SonarQube.Client NuGet包

SonarCloud API与SonarQube兼容，官方客户端包可简化调用流程：

1. 安装NuGet包：

Install-Package SonarQube.Client

或用.NET CLI：

dotnet add package SonarQube.Client

2. 初始化客户端并调用API：

using SonarQube.Client;
using SonarQube.Client.Models;

var sonarToken = "你的SonarCloud令牌";
var baseUrl = "https://sonarcloud.io";

using var client = await SonarQubeClient.CreateAsync(new Uri(baseUrl));
await client.AuthenticateAsync(sonarToken, string.Empty); // 密码留空

// 示例：获取所有项目
var projects = await client.GetProjectsAsync();
foreach (var project in projects)
{
    Console.WriteLine($"项目Key: {project.Key}, 名称: {project.Name}");
    // 可直接将project数据写入数据库
}

注意事项 #

• 令牌保密：绝对不要将令牌硬编码到代码中，优先使用环境变量、加密配置文件或密钥管理服务存储
• 权限最小化：生成令牌时仅授予必要权限，比如Browse和Read Analysis Data只读权限足够大部分查询类API使用
• 错误处理：实际代码中需添加异常捕获（如HttpRequestException），处理API返回的4xx/5xx错误状态码
• API有效性：调用前确认目标API端点为SonarCloud当前支持的版本

内容的提问来源于stack exchange，提问作者Diego Ahumada Delvillar