BodyAttribute Class

Reference

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:: BodyAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the body for the API request.

public ref class BodyAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Parameter)>]
[<System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")>]
type BodyAttribute = class
    inherit Attribute

Public NotInheritable Class BodyAttribute
Inherits Attribute

Inheritance: Object

Attribute
BodyAttribute

Attributes: AttributeUsageAttribute ConditionalAttribute

Examples

[AutoClient("MyClient")]
interface IMyDependencyClient
{
    [Post("/api/users")]
    Task<User> PostUserAsync([Body] User user, CancellationToken cancellationToken);
}

Remarks

Marks a method parameter as the body for the request. This attribute cannot be used with a GET or HEAD request.

Constructors

BodyAttribute()	Initializes a new instance of the BodyAttribute class.
BodyAttribute(BodyContentType)	Initializes a new instance of the BodyAttribute class.

Properties

ContentType

Gets the body content type.

Applies to

Share via