Skip to content

Clarify WeatherApiClient is part of Aspire starter template #3691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 3 commits into from
Closed

Clarify WeatherApiClient is part of Aspire starter template #3691

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee5f146
Initial plan
Copilot Jan 30, 2026
3187212
Clarify WeatherApiClient is created by Aspire template
Copilot Jan 30, 2026
184a834
Fix spacing in return type
Copilot Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/frameworks/aspire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ It assumes you started with an Aspire project created using the following comman
aspire new aspire-starter --name MyService
```

> **Note:** The Aspire starter template automatically creates a `WeatherApiClient` class in the `MyService.Web` project. This typed HttpClient is used throughout this guide to demonstrate calling the protected API. You don't need to create this class yourself—it's part of the template.

---

## Quick Start (TL;DR)
Expand Down Expand Up @@ -76,6 +78,7 @@ builder.Services.AddAuthentication(OpenIdConnectDefaults.AuthenticationScheme)
.EnableTokenAcquisitionToCallDownstreamApi()
.AddInMemoryTokenCaches();

// WeatherApiClient is created by the Aspire starter template
builder.Services.AddHttpClient<WeatherApiClient>(client =>
client.BaseAddress = new("https+http://apiservice"))
.AddMicrosoftIdentityMessageHandler(builder.Configuration.GetSection("WeatherApi"));
Expand Down Expand Up @@ -127,7 +130,7 @@ flowchart LR
1. **User visits Blazor app** → Not authenticated → sees "Login" button
2. **User clicks Login** → Redirects to `/authentication/login` → OIDC challenge → Entra ID
3. **User signs in** → Entra ID redirects to `/signin-oidc` → cookie established
4. **User navigates to Weather page** → Blazor calls `WeatherApiClient.GetAsync()`
4. **User navigates to Weather page** → Blazor calls `WeatherApiClient.GetAsync()` (the typed client created by the Aspire template)
5. **`MicrosoftIdentityMessageHandler`** intercepts the request:
- Checks token cache for valid access token
- If expired/missing, silently acquires new token using refresh token
Expand Down Expand Up @@ -805,7 +808,7 @@ builder.Services.AddHttpClient<WeatherApiClient>(client =>

### 4.4: Override Options Per Request

Override default options on a per-request basis using the `WithAuthenticationOptions` extension method:
Override default options on a per-request basis using the `WithAuthenticationOptions` extension method. This example extends the `WeatherApiClient` class (created by the Aspire starter template) to add a method that uses different scopes:

```csharp
public class WeatherApiClient
Expand All @@ -817,7 +820,7 @@ public class WeatherApiClient
_httpClient = httpClient;
}

public async Task<WeatherForecast[]? > GetSensitiveDataAsync()
public async Task<WeatherForecast[]?> GetSensitiveDataAsync()
{
// Override scopes for this specific request
var request = new HttpRequestMessage(HttpMethod.Get, "/weatherforecast")
Expand Down