Skip to content

[New article]: .NET MAUI integration with Aspire (Aspire.Hosting.Maui) #5194

@jfversluis

Description

@jfversluis

Proposed topic or title

We need documentation for the new .NET MAUI integration with Aspire that allows developers to orchestrate MAUI applications alongside backend services in an Aspire AppHost.

Location in table of contents.

No response

Reason for the article

Adding the .NET MAUI integration to Aspire, will be good for people to learn how to get started, as well as some things to be aware of.

Article abstract

Key topics to cover:

  1. Getting Started

    • How to add a MAUI project to an Aspire AppHost using AddMauiProject()
    • Platform-specific configuration with .WithWindows(), .WithAndroid(), .WithiOS(), .WithMacCatalyst()
    • Prerequisites (MAUI workload installation)
  2. Service Integration

    • Connecting MAUI apps to backend services with .WithReference()
    • Automatic service discovery in MAUI apps
    • Using dev tunnels for mobile device communication with .WithOtlpDevTunnel()
  3. OpenTelemetry Integration

    • Setting up telemetry in MAUI apps with MauiServiceDefaults
    • Viewing MAUI app traces and metrics in Aspire Dashboard
    • Telemetry over dev tunnels for mobile platforms
  4. Platform-Specific Scenarios

    • Running on Windows desktop
    • Running on Android emulators/devices
    • Running on iOS simulators/devices
    • Running on macCatalyst
  5. API Reference

    • AddMauiProject() extension method
    • MauiProjectBuilder methods
    • Platform configuration options (emulator/device selection, runtime identifiers)

Relevant searches

MAUI iOS Android macOS Windows diagnostics tracing telemetry integration mobile cross-platform

Metadata

Metadata

Assignees

No one assigned

    Labels

    Pri1High priority, do before Pri2 and Pri3area-docsdoc-ideaIndicates issues that are suggestions for new topics [org][type][category]

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions