HeaderAttribute Class

Definition

Namespace:

Microsoft.Extensions.Http.AutoClient

Assembly:

Microsoft.Extensions.Http.AutoClient.dll

Package:

Microsoft.Extensions.Http.AutoClient v8.0.0-rc.2.23510.2

Source:

HeaderAttribute.cs

Defines a header to be used in the API request.

C#

[System.AttributeUsage(System.AttributeTargets.Parameter)]
[System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")]
public sealed class HeaderAttribute : Attribute

Inheritance

Object

Attribute

HeaderAttribute

Attributes

AttributeUsageAttribute ConditionalAttribute

Examples

[AutoClient("MyClient")]
interface IMyDependencyClient
{
    [Get("/api/users")]
    Task<string> GetUsersAsync([Header("X-UserName")] string userName, CancellationToken cancellationToken);
}

Remarks

Marks a method parameter as a header to insert in the request.

Constructors

HeaderAttribute(String)

Initializes a new instance of the HeaderAttribute class.

Properties

Header

Gets the name of the header.

Applies to