.NET6 WebAPI无法添加为连接服务，需排查缺失配置项

要让.NET6搭建的WebAPI能被正常添加为OpenAPI服务引用，需要补充以下配置和检查：

1. 确保Swagger/OpenAPI元数据正确暴露 #

在Program.cs中确认Swagger配置完整，保证swagger.json可正常访问：

// 注册Swagger生成服务
builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "你的API名称", Version = "v1" });
});

// 启用Swagger中间件（放在路由配置之前）
app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "你的API V1");
});

运行WebAPI后，确认https://localhost:44341/swagger/v1/swagger.json可在浏览器中打开并显示完整的OpenAPI定义。

2. 解决本地HTTPS证书信任问题 #

本地开发的自签名HTTPS证书可能被服务引用工具判定为不安全，导致元数据下载失败。执行以下命令信任本地开发证书：

dotnet dev-certs https --trust

按提示完成证书信任操作即可。

3. 验证WebAPI运行端口与URL一致性 #

检查launchSettings.json中的applicationUrl配置，确保HTTPS端口与你使用的44341一致：

"profiles": {
  "https": {
    "applicationUrl": "https://localhost:44341;http://localhost:5001",
    "environmentVariables": {
      "ASPNETCORE_ENVIRONMENT": "Development"
    }
  }
}

运行WebAPI时，确认控制台输出的监听地址包含https://localhost:44341。

4. 确保客户端项目安装必要的NuGet包 #

在添加服务引用的控制台项目中，提前安装OpenAPI代码生成所需的包：

dotnet add package Microsoft.Extensions.ApiDescription.Client

或者在Visual Studio添加服务引用时，勾选“自动安装所需的NuGet包”选项。

5. 排查跨域访问限制（可选） #

如果工具访问WebAPI时存在跨域拦截，可临时添加CORS配置允许所有请求（仅开发环境使用）：

builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowAll", policy =>
    {
        policy.AllowAnyOrigin()
              .AllowAnyMethod()
              .AllowAnyHeader();
    });
});

// 启用CORS中间件（需放在UseRouting之后，UseEndpoints之前）
app.UseCors("AllowAll");

最后注意 #

添加服务引用时，务必输入完整的swagger.json URL（即https://localhost:44341/swagger/v1/swagger.json），而非根地址https://localhost:44341/，避免工具错误地从根地址尝试下载元数据。

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