AspireDtoAttribute

Docs/Reference/Search C# APIs/Aspire.Hosting/AspireDtoAttribute

AspireDtoAttribute

Docs Reference Search C# APIs Aspire.Hosting AspireDtoAttribute

Classsealednet10.0

📦 Aspire.Hosting v13.5.3

Marks a class as an ATS (Aspire Type System) Data Transfer Object. DTOs are serializable types used to pass structured data to capabilities.

namespace Aspire.Hosting;

public sealed class AspireDtoAttribute
    : System.Attribute
{
    // ...
}

Attribute

Inherits

Attribute→AspireDtoAttribute

Source

Remarks

DTOs should be simple record or class types with properties that can be serialized to/from JSON. They should not contain complex .NET types like IConfiguration, ILogger, or other framework-specific types.

Example:

[AspireDto]
public sealed class AddRedisOptions {
    public required string Name { get; init; }
    public int? Port { get; init; }
}

Constructors1

AspireDtoAttribute

View all constructors

Properties1

DtoTypeIdget; set

string?

Gets or sets an optional type identifier for this DTO. If not specified, the DTO will be serialized as a plain JSON object.

View all properties