如何在.NET Aspire中让OpenAPI生成客户端实现服务发现？

架构老林

2026-6-16

解决.NET Aspire中OpenAPI生成客户端的服务发现问题

解决方案

1. 调整OpenAPI生成器配置，禁用BasePath生成

生成客户端时，通过配置让OpenAPI Generator不生成硬编码的BasePath属性，这样客户端会直接使用HttpClient的BaseAddress发起请求：

若用CLI生成，添加参数：openapi-generator-cli generate ... --skip-base-path
若通过.NET项目文件（csproj）配置生成，添加以下属性：
```
<PropertyGroup>
  <SkipBasePath>true</SkipBasePath>
</PropertyGroup>
```

2. 用Aspire服务发现注册客户端

在Blazor WASM的Program.cs中，使用Aspire的扩展方法注册生成的客户端，自动集成服务发现：

builder.AddHttpClient<YourGeneratedApiClient>()
       .WithServiceDiscovery();

Aspire会自动解析服务地址并设置到HttpClient的BaseAddress，生成的客户端因为没有BasePath，会直接使用该地址发起请求。

3. 手动覆盖已生成客户端的BasePath（应急方案）

如果无法重新生成客户端，可在注册时手动清空BasePath：

builder.Services.AddHttpClient<YourGeneratedApiClient>()
       .WithServiceDiscovery()
       .AddTypedClient(client =>
       {
           var apiClient = new YourGeneratedApiClient(client);
           apiClient.BasePath = string.Empty; // 覆盖生成的默认BasePath
           return apiClient;
       });

最佳实践

统一依赖HttpClient的BaseAddress：避免OpenAPI客户端硬编码地址，完全依托Aspire的服务发现、配置管理能力。
强制启用服务发现：所有客户端注册时都添加.WithServiceDiscovery()，无需手动读取services:apiservice:https:0这类配置键。
AppHost中正确注册服务：确保API服务在Aspire AppHost中通过builder.AddProject<Projects.Apiservice>("apiservice")注册，Aspire会自动维护服务发现条目。
配置绑定替代手动读取：如果需要自定义客户端配置，用Aspire的配置绑定机制，比如：
```
builder.Services.Configure<ApiClientSettings>(configuration.GetSection("ApiClient"));
```